speiger.src.collections.shorts.sets

Interface ShortSortedSet

All Superinterfaces:

java.util.Collection<java.lang.Short>, java.lang.Iterable<java.lang.Short>, java.util.Set<java.lang.Short>, ShortCollection, ShortIterable, ShortSet, java.util.SortedSet<java.lang.Short>

All Known Subinterfaces:

ShortNavigableSet

All Known Implementing Classes:

ShortArraySet, ShortAVLTreeSet, ShortLinkedOpenCustomHashSet, ShortLinkedOpenHashSet, ShortRBTreeSet

public interface ShortSortedSet
extends ShortSet, java.util.SortedSet<java.lang.Short>

A Type Specific SortedSet implementation to reduce boxing/unboxing with a couple extra methods that allow greater control over sets.

Method Summary

Modifier and Type	Method and Description
boolean	addAndMoveToFirst(short o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(short o) A customized add method that allows you to insert into the last index.
ShortComparator	comparator() A Type Specific Comparator method
default java.lang.Short	first() Deprecated.
short	firstShort() A method to get the first element in the set
ShortSortedSet	headSet(short toElement) A Type Specific HeadSet method to reduce boxing/unboxing
default ShortSortedSet	headSet(java.lang.Short toElement) Deprecated.
ShortBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
ShortBidirectionalIterator	iterator(short fromElement) A type Specific Iterator starting from a given key
default java.lang.Short	last() Deprecated.
short	lastShort() A method to get the last element in the set
boolean	moveToFirst(short o) A specific move method to move a given key to the first index.
boolean	moveToLast(short o) A specific move method to move a given key to the last index.
short	pollFirstShort() A method to get and remove the first element in the set
short	pollLastShort() A method to get and remove the last element in the set
default ShortSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
ShortSortedSet	subSet(short fromElement, short toElement) A Type Specific SubSet method to reduce boxing/unboxing
default ShortSortedSet	subSet(java.lang.Short fromElement, java.lang.Short toElement) Deprecated.
ShortSortedSet	tailSet(short fromElement) A Type Specific TailSet method to reduce boxing/unboxing
default ShortSortedSet	tailSet(java.lang.Short fromElement) Deprecated.

Methods inherited from interface speiger.src.collections.shorts.sets.ShortSet

add, contains, remove, remove, remShort

Methods inherited from interface speiger.src.collections.shorts.collections.ShortCollection

add, addAll, contains, containsAll, containsAny, containsAny, parallelPrimitiveStream, primitiveStream, remIf, removeAll, removeIf, retainAll, toShortArray, toShortArray

Methods inherited from interface speiger.src.collections.shorts.collections.ShortIterable

forEach, forEach

Methods inherited from interface java.util.Set

addAll, clear, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, stream

Method Detail

addAndMoveToFirst

boolean addAndMoveToFirst(short o)

A customized add method that allows you to insert into the first index.

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

Note:

some implementations do not support this method

addAndMoveToLast

boolean addAndMoveToLast(short o)

A customized add method that allows you to insert into the last index.

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

Note:

some implementations do not support this method

moveToFirst

boolean moveToFirst(short o)

A specific move method to move a given key to the first index.

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place, some implementations do not support this method

moveToLast

boolean moveToLast(short o)

A specific move method to move a given key to the last index.

Parameters:

o - that should be moved to the first last

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place, some implementations do not support this method

comparator

ShortComparator comparator()

A Type Specific Comparator method

Specified by:

comparator in interface java.util.SortedSet<java.lang.Short>

Returns:

the type specific comparator

iterator

ShortBidirectionalIterator iterator()

Description copied from interface: ShortCollection

Returns a Type-Specific Iterator to reduce (un)boxing

Specified by:

iterator in interface java.util.Collection<java.lang.Short>

Specified by:

iterator in interface java.lang.Iterable<java.lang.Short>

Specified by:

iterator in interface java.util.Set<java.lang.Short>

Specified by:

iterator in interface ShortCollection

Specified by:

iterator in interface ShortIterable

Specified by:

iterator in interface ShortSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

ShortBidirectionalIterator iterator(short fromElement)

A type Specific Iterator starting from a given key

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

Throws:

java.util.NoSuchElementException - if fromElement isn't found

spliterator

default ShortSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

spliterator in interface java.util.Collection<java.lang.Short>

Specified by:

spliterator in interface java.lang.Iterable<java.lang.Short>

Specified by:

spliterator in interface java.util.Set<java.lang.Short>

Specified by:

spliterator in interface ShortCollection

Specified by:

spliterator in interface ShortIterable

Specified by:

spliterator in interface ShortSet

Specified by:

spliterator in interface java.util.SortedSet<java.lang.Short>

Returns:

type specific splititerator

subSet

ShortSortedSet subSet(short fromElement,
                      short toElement)

A Type Specific SubSet method to reduce boxing/unboxing

Parameters:

fromElement - where the SubSet should start

toElement - where the SubSet should end

Returns:

a SubSet that is within the range of the desired range

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

headSet

ShortSortedSet headSet(short toElement)

A Type Specific HeadSet method to reduce boxing/unboxing

Parameters:

toElement - where the HeadSet should end

Returns:

a HeadSet that is within the range of the desired range

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

tailSet

ShortSortedSet tailSet(short fromElement)

A Type Specific TailSet method to reduce boxing/unboxing

Parameters:

fromElement - where the TailSet should start

Returns:

a TailSet that is within the range of the desired range

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

firstShort

short firstShort()

A method to get the first element in the set

Returns:

first element in the set

pollFirstShort

short pollFirstShort()

A method to get and remove the first element in the set

Returns:

first element in the set

lastShort

short lastShort()

A method to get the last element in the set

Returns:

last element in the set

pollLastShort

short pollLastShort()

A method to get and remove the last element in the set

Returns:

last element in the set

subSet

@Deprecated
default ShortSortedSet subSet(java.lang.Short fromElement,
                                           java.lang.Short toElement)

Deprecated.

Specified by:

subSet in interface java.util.SortedSet<java.lang.Short>

headSet

@Deprecated
default ShortSortedSet headSet(java.lang.Short toElement)

Deprecated.

Specified by:

headSet in interface java.util.SortedSet<java.lang.Short>

tailSet

@Deprecated
default ShortSortedSet tailSet(java.lang.Short fromElement)

Deprecated.

Specified by:

tailSet in interface java.util.SortedSet<java.lang.Short>

first

@Deprecated
default java.lang.Short first()

Deprecated.

Specified by:

first in interface java.util.SortedSet<java.lang.Short>

last

@Deprecated
default java.lang.Short last()

Deprecated.

Specified by:

last in interface java.util.SortedSet<java.lang.Short>