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:

ShortAVLTreeSet, 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.

Note:

ShortOrderedSet is only extended until 0.6.0 for Compat reasons. The supported classes already implement ShortOrderedSet directly and will remove ShortSortedSet implementations in favor of ShortOrderedSet instead

Method Summary

Modifier and Type	Method and Description
ShortComparator	comparator() A Type Specific Comparator method
ShortSortedSet	copy() A Function that does a shallow clone of the Collection itself.
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
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.
default ShortSortedSet	synchronize() Creates a Wrapped SortedSet that is Synchronized
default ShortSortedSet	synchronize(java.lang.Object mutex) Creates a Wrapped SortedSet that is Synchronized
ShortSortedSet	tailSet(short fromElement) A Type Specific TailSet method to reduce boxing/unboxing
default ShortSortedSet	tailSet(java.lang.Short fromElement) Deprecated.
default ShortSortedSet	unmodifiable() Creates a Wrapped SortedSet that is unmodifiable

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, addAll, addAll, addAll, contains, containsAll, containsAny, containsAny, parallelPrimitiveStream, pour, primitiveStream, remIf, removeAll, removeAll, removeIf, retainAll, retainAll, toShortArray, toShortArray

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

arrayflatMap, asAsync, count, distinct, filter, findFirst, flatMap, forEach, forEach, forEach, limit, map, matchesAll, matchesAny, matchesNone, peek, pourAsList, pourAsSet, reduce, reduce, sorted

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

comparator

ShortComparator comparator()

A Type Specific Comparator method

Specified by:

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

Returns:

the type specific comparator

copy

ShortSortedSet copy()

Description copied from interface: ShortCollection

A Function that does a shallow clone of the Collection itself. This function is more optimized then a copy constructor since the Collection does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk

Specified by:

copy in interface ShortCollection

Specified by:

copy in interface ShortSet

Returns:

a Shallow Copy of the collection

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

synchronize

default ShortSortedSet synchronize()

Creates a Wrapped SortedSet that is Synchronized

Specified by:

synchronize in interface ShortCollection

Specified by:

synchronize in interface ShortSet

Returns:

a new SortedSet that is synchronized

See Also:

ShortSets.synchronize(speiger.src.collections.shorts.sets.ShortSet)

synchronize

default ShortSortedSet synchronize(java.lang.Object mutex)

Creates a Wrapped SortedSet that is Synchronized

Specified by:

synchronize in interface ShortCollection

Specified by:

synchronize in interface ShortSet

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedSet Wrapper that is synchronized

See Also:

ShortSets.synchronize(speiger.src.collections.shorts.sets.ShortSet)

unmodifiable

default ShortSortedSet unmodifiable()

Creates a Wrapped SortedSet that is unmodifiable

Specified by:

unmodifiable in interface ShortCollection

Specified by:

unmodifiable in interface ShortSet

Returns:

a new SortedSet Wrapper that is unmodifiable

See Also:

ShortSets.unmodifiable(speiger.src.collections.shorts.sets.ShortSet)

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>