speiger.src.collections.ints.sets

Interface IntNavigableSet

All Superinterfaces:

java.util.Collection<java.lang.Integer>, IntCollection, IntIterable, IntSet, IntSortedSet, ISizeProvider, java.lang.Iterable<java.lang.Integer>, java.util.NavigableSet<java.lang.Integer>, java.util.Set<java.lang.Integer>, java.util.SortedSet<java.lang.Integer>

All Known Implementing Classes:

IntAVLTreeSet, IntRBTreeSet

public interface IntNavigableSet
extends java.util.NavigableSet<java.lang.Integer>, IntSortedSet

A Type Specific Navigable Set interface with a couple helper methods

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.utils.ISizeProvider

ISizeProvider.CollectionSize

Method Summary

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

Methods inherited from interface speiger.src.collections.ints.sets.IntSortedSet

comparator, firstInt, iterator, lastInt, pollFirstInt, pollLastInt

Methods inherited from interface speiger.src.collections.ints.sets.IntSet

add, contains, remInt, remove, remove

Methods inherited from interface speiger.src.collections.ints.collections.IntCollection

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

Methods inherited from interface speiger.src.collections.ints.collections.IntIterable

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

Methods inherited from interface speiger.src.collections.utils.ISizeProvider

of, size

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

int lower(int 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

int higher(int 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

int floor(int 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

int ceiling(int 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(int e)

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

Parameters:

e - the new max value

getDefaultMaxValue

int getDefaultMaxValue()

A Helper method to get the max value for SubSets.

Returns:

the default max value.

setDefaultMinValue

void setDefaultMinValue(int e)

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

Parameters:

e - the new min value

getDefaultMinValue

int getDefaultMinValue()

A Helper method to get the min value for SubSets.

Returns:

the default min value.

subSet

default IntNavigableSet subSet(int fromElement,
                               int toElement)

Description copied from interface: IntSortedSet

A Type Specific SubSet method to reduce boxing/unboxing

Specified by:

subSet in interface IntSortedSet

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 IntNavigableSet headSet(int toElement)

Description copied from interface: IntSortedSet

A Type Specific HeadSet method to reduce boxing/unboxing

Specified by:

headSet in interface IntSortedSet

Parameters:

toElement - where the HeadSet should end

Returns:

a HeadSet that is within the range of the desired range

tailSet

default IntNavigableSet tailSet(int fromElement)

Description copied from interface: IntSortedSet

A Type Specific TailSet method to reduce boxing/unboxing

Specified by:

tailSet in interface IntSortedSet

Parameters:

fromElement - where the TailSet should start

Returns:

a TailSet that is within the range of the desired range

subSet

IntNavigableSet subSet(int fromElement,
                       boolean fromInclusive,
                       int 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

IntNavigableSet headSet(int 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

IntNavigableSet tailSet(int 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

IntBidirectionalIterator iterator()

Description copied from interface: IntCollection

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

Specified by:

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

Specified by:

iterator in interface IntCollection

Specified by:

iterator in interface IntIterable

Specified by:

iterator in interface IntSet

Specified by:

iterator in interface IntSortedSet

Specified by:

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

Specified by:

iterator in interface java.util.NavigableSet<java.lang.Integer>

Specified by:

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

Returns:

a Type Specific iterator

See Also:

Collection.iterator()

descendingIterator

IntBidirectionalIterator descendingIterator()

Specified by:

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

Returns:

a Type Specific desendingIterator

descendingSet

IntNavigableSet descendingSet()

Specified by:

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

Returns:

a Type Specific desendingSet

copy

IntNavigableSet copy()

Description copied from interface: IntCollection

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 IntCollection

Specified by:

copy in interface IntSet

Specified by:

copy in interface IntSortedSet

Returns:

a Shallow Copy of the collection

synchronize

default IntNavigableSet synchronize()

Creates a Wrapped NavigableSet that is Synchronized

Specified by:

synchronize in interface IntCollection

Specified by:

synchronize in interface IntSet

Specified by:

synchronize in interface IntSortedSet

Returns:

a new NavigableSet that is synchronized

See Also:

IntSets.synchronize(speiger.src.collections.ints.sets.IntSet)

synchronize

default IntNavigableSet synchronize(java.lang.Object mutex)

Creates a Wrapped NavigableSet that is Synchronized

Specified by:

synchronize in interface IntCollection

Specified by:

synchronize in interface IntSet

Specified by:

synchronize in interface IntSortedSet

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableSet Wrapper that is synchronized

See Also:

IntSets.synchronize(speiger.src.collections.ints.sets.IntSet)

unmodifiable

default IntNavigableSet unmodifiable()

Creates a Wrapped NavigableSet that is unmodifiable

Specified by:

unmodifiable in interface IntCollection

Specified by:

unmodifiable in interface IntSet

Specified by:

unmodifiable in interface IntSortedSet

Returns:

a new NavigableSet Wrapper that is unmodifiable

See Also:

IntSets.unmodifiable(speiger.src.collections.ints.sets.IntSet)

spliterator

default IntSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

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

Specified by:

spliterator in interface IntCollection

Specified by:

spliterator in interface IntIterable

Specified by:

spliterator in interface IntSet

Specified by:

spliterator in interface IntSortedSet

Specified by:

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

Specified by:

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

Specified by:

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

Returns:

type specific splititerator

lower

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

Deprecated.

Specified by:

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

floor

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

Deprecated.

Specified by:

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

ceiling

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

Deprecated.

Specified by:

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

higher

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

Deprecated.

Specified by:

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

first

@Deprecated
default java.lang.Integer first()

Deprecated.

Specified by:

first in interface IntSortedSet

Specified by:

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

last

@Deprecated
default java.lang.Integer last()

Deprecated.

Specified by:

last in interface IntSortedSet

Specified by:

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

pollFirst

@Deprecated
default java.lang.Integer pollFirst()

Deprecated.

Specified by:

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

pollLast

@Deprecated
default java.lang.Integer pollLast()

Deprecated.

Specified by:

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

subSet

@Deprecated
default IntNavigableSet subSet(java.lang.Integer fromElement,
                                            boolean fromInclusive,
                                            java.lang.Integer toElement,
                                            boolean toInclusive)

Deprecated.

Specified by:

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

headSet

@Deprecated
default IntNavigableSet headSet(java.lang.Integer toElement,
                                             boolean inclusive)

Deprecated.

Specified by:

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

tailSet

@Deprecated
default IntNavigableSet tailSet(java.lang.Integer fromElement,
                                             boolean inclusive)

Deprecated.

Specified by:

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

subSet

@Deprecated
default IntSortedSet subSet(java.lang.Integer fromElement,
                                         java.lang.Integer toElement)

Deprecated.

Specified by:

subSet in interface IntSortedSet

Specified by:

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

Specified by:

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

headSet

@Deprecated
default IntSortedSet headSet(java.lang.Integer toElement)

Deprecated.

Specified by:

headSet in interface IntSortedSet

Specified by:

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

Specified by:

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

tailSet

@Deprecated
default IntSortedSet tailSet(java.lang.Integer fromElement)

Deprecated.

Specified by:

tailSet in interface IntSortedSet

Specified by:

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

Specified by:

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