speiger.src.collections.shorts.sets

Interface ShortNavigableSet

All Superinterfaces:

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

All Known Implementing Classes:

ShortAVLTreeSet, ShortRBTreeSet

public interface ShortNavigableSet
extends java.util.NavigableSet<java.lang.Short>, ShortSortedSet

A Type Specific Navigable Set interface with a couple helper methods

Method Summary

Modifier and Type	Method and Description
short	ceiling(short key) A Type Specific ceiling method to reduce boxing/unboxing.
default java.lang.Short	ceiling(java.lang.Short e) Deprecated.
ShortNavigableSet	copy() A Function that does a shallow clone of the Collection itself.
ShortBidirectionalIterator	descendingIterator()
ShortNavigableSet	descendingSet()
default java.lang.Short	first() Deprecated.
short	floor(short key) A Type Specific floor method to reduce boxing/unboxing.
default java.lang.Short	floor(java.lang.Short e) Deprecated.
short	getDefaultMaxValue() A Helper method to get the max value for SubSets.
short	getDefaultMinValue() A Helper method to get the min value for SubSets.
default ShortNavigableSet	headSet(short toElement) A Type Specific HeadSet method to reduce boxing/unboxing
default ShortSortedSet	headSet(java.lang.Short toElement) Deprecated.
ShortNavigableSet	headSet(short toElement, boolean inclusive) A Type Specific HeadSet method to reduce boxing/unboxing
default ShortNavigableSet	headSet(java.lang.Short toElement, boolean inclusive) Deprecated.
short	higher(short key) A Type Specific higher method to reduce boxing/unboxing.
default java.lang.Short	higher(java.lang.Short e) Deprecated.
ShortBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
default java.lang.Short	last() Deprecated.
short	lower(short key) A Type Specific lower method to reduce boxing/unboxing.
default java.lang.Short	lower(java.lang.Short e) Deprecated.
default java.lang.Short	pollFirst() Deprecated.
default java.lang.Short	pollLast() Deprecated.
void	setDefaultMaxValue(short e) A Helper method to set the max value for SubSets.
void	setDefaultMinValue(short e) A Helper method to set the min value for SubSets.
default ShortSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
ShortNavigableSet	subSet(short fromElement, boolean fromInclusive, short toElement, boolean toInclusive) A Type Specific SubSet method to reduce boxing/unboxing
default ShortNavigableSet	subSet(java.lang.Short fromElement, boolean fromInclusive, java.lang.Short toElement, boolean toInclusive) Deprecated.
default ShortNavigableSet	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 ShortNavigableSet	synchronize() Creates a Wrapped NavigableSet that is Synchronized
default ShortNavigableSet	synchronize(java.lang.Object mutex) Creates a Wrapped NavigableSet that is Synchronized
default ShortNavigableSet	tailSet(short fromElement) A Type Specific TailSet method to reduce boxing/unboxing
default ShortSortedSet	tailSet(java.lang.Short fromElement) Deprecated.
ShortNavigableSet	tailSet(short fromElement, boolean inclusive) A Type Specific TailSet method to reduce boxing/unboxing
default ShortNavigableSet	tailSet(java.lang.Short fromElement, boolean inclusive) Deprecated.
default ShortNavigableSet	unmodifiable() Creates a Wrapped NavigableSet that is unmodifiable

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

comparator, firstShort, iterator, lastShort, pollFirstShort, pollLastShort

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

lower

short lower(short key)

A Type Specific lower method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the greatest lower key that can be found

higher

short higher(short key)

A Type Specific higher method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the lowest higher key that can be found

floor

short floor(short key)

A Type Specific floor method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal key that can be found

ceiling

short ceiling(short key)

A Type Specific ceiling method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal key that can be found

setDefaultMaxValue

void setDefaultMaxValue(short e)

A Helper method to set the max value for SubSets. (Default: short.MIN_VALUE)

Parameters:

e - the new max value

getDefaultMaxValue

short getDefaultMaxValue()

A Helper method to get the max value for SubSets.

Returns:

the default max value.

setDefaultMinValue

void setDefaultMinValue(short e)

A Helper method to set the min value for SubSets. (Default: short.MAX_VALUE)

Parameters:

e - the new min value

getDefaultMinValue

short getDefaultMinValue()

A Helper method to get the min value for SubSets.

Returns:

the default min value.

subSet

default ShortNavigableSet subSet(short fromElement,
                                 short toElement)

Description copied from interface: ShortSortedSet

A Type Specific SubSet method to reduce boxing/unboxing

Specified by:

subSet in interface ShortSortedSet

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

headSet

default ShortNavigableSet headSet(short toElement)

Description copied from interface: ShortSortedSet

A Type Specific HeadSet method to reduce boxing/unboxing

Specified by:

headSet in interface ShortSortedSet

Parameters:

toElement - where the HeadSet should end

Returns:

a HeadSet that is within the range of the desired range

tailSet

default ShortNavigableSet tailSet(short fromElement)

Description copied from interface: ShortSortedSet

A Type Specific TailSet method to reduce boxing/unboxing

Specified by:

tailSet in interface ShortSortedSet

Parameters:

fromElement - where the TailSet should start

Returns:

a TailSet that is within the range of the desired range

subSet

ShortNavigableSet subSet(short fromElement,
                         boolean fromInclusive,
                         short toElement,
                         boolean toInclusive)

A Type Specific SubSet method to reduce boxing/unboxing

Parameters:

fromElement - where the SubSet should start

fromInclusive - if the fromElement is inclusive or not

toElement - where the SubSet should end

toInclusive - if the toElement is inclusive or not

Returns:

a SubSet that is within the range of the desired range

headSet

ShortNavigableSet headSet(short toElement,
                          boolean inclusive)

A Type Specific HeadSet method to reduce boxing/unboxing

Parameters:

toElement - where the HeadSet should end

inclusive - if the toElement is inclusive or not

Returns:

a HeadSet that is within the range of the desired range

tailSet

ShortNavigableSet tailSet(short fromElement,
                          boolean inclusive)

A Type Specific TailSet method to reduce boxing/unboxing

Parameters:

fromElement - where the TailSet should start

inclusive - if the fromElement is inclusive or not

Returns:

a TailSet that is within the range of the desired range

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.NavigableSet<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

Specified by:

iterator in interface ShortSortedSet

Returns:

a Type Specific iterator

See Also:

Collection.iterator()

descendingIterator

ShortBidirectionalIterator descendingIterator()

Specified by:

descendingIterator in interface java.util.NavigableSet<java.lang.Short>

Returns:

a Type Specific desendingIterator

descendingSet

ShortNavigableSet descendingSet()

Specified by:

descendingSet in interface java.util.NavigableSet<java.lang.Short>

Returns:

a Type Specific desendingSet

copy

ShortNavigableSet 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

Specified by:

copy in interface ShortSortedSet

Returns:

a Shallow Copy of the collection

synchronize

default ShortNavigableSet synchronize()

Creates a Wrapped NavigableSet that is Synchronized

Specified by:

synchronize in interface ShortCollection

Specified by:

synchronize in interface ShortSet

Specified by:

synchronize in interface ShortSortedSet

Returns:

a new NavigableSet that is synchronized

See Also:

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

synchronize

default ShortNavigableSet synchronize(java.lang.Object mutex)

Creates a Wrapped NavigableSet that is Synchronized

Specified by:

synchronize in interface ShortCollection

Specified by:

synchronize in interface ShortSet

Specified by:

synchronize in interface ShortSortedSet

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableSet Wrapper that is synchronized

See Also:

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

unmodifiable

default ShortNavigableSet unmodifiable()

Creates a Wrapped NavigableSet that is unmodifiable

Specified by:

unmodifiable in interface ShortCollection

Specified by:

unmodifiable in interface ShortSet

Specified by:

unmodifiable in interface ShortSortedSet

Returns:

a new NavigableSet 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 ShortSortedSet

Specified by:

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

Returns:

type specific splititerator

lower

@Deprecated
default java.lang.Short lower(java.lang.Short e)

Deprecated.

Specified by:

lower in interface java.util.NavigableSet<java.lang.Short>

floor

@Deprecated
default java.lang.Short floor(java.lang.Short e)

Deprecated.

Specified by:

floor in interface java.util.NavigableSet<java.lang.Short>

ceiling

@Deprecated
default java.lang.Short ceiling(java.lang.Short e)

Deprecated.

Specified by:

ceiling in interface java.util.NavigableSet<java.lang.Short>

higher

@Deprecated
default java.lang.Short higher(java.lang.Short e)

Deprecated.

Specified by:

higher in interface java.util.NavigableSet<java.lang.Short>

first

@Deprecated
default java.lang.Short first()

Deprecated.

Specified by:

first in interface ShortSortedSet

Specified by:

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

last

@Deprecated
default java.lang.Short last()

Deprecated.

Specified by:

last in interface ShortSortedSet

Specified by:

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

pollFirst

@Deprecated
default java.lang.Short pollFirst()

Deprecated.

Specified by:

pollFirst in interface java.util.NavigableSet<java.lang.Short>

pollLast

@Deprecated
default java.lang.Short pollLast()

Deprecated.

Specified by:

pollLast in interface java.util.NavigableSet<java.lang.Short>

subSet

@Deprecated
default ShortNavigableSet subSet(java.lang.Short fromElement,
                                              boolean fromInclusive,
                                              java.lang.Short toElement,
                                              boolean toInclusive)

Deprecated.

Specified by:

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

headSet

@Deprecated
default ShortNavigableSet headSet(java.lang.Short toElement,
                                               boolean inclusive)

Deprecated.

Specified by:

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

tailSet

@Deprecated
default ShortNavigableSet tailSet(java.lang.Short fromElement,
                                               boolean inclusive)

Deprecated.

Specified by:

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

subSet

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

Deprecated.

Specified by:

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

Specified by:

subSet in interface ShortSortedSet

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.NavigableSet<java.lang.Short>

Specified by:

headSet in interface ShortSortedSet

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.NavigableSet<java.lang.Short>

Specified by:

tailSet in interface ShortSortedSet

Specified by:

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