speiger.src.collections.bytes.sets

Interface ByteNavigableSet

All Superinterfaces:

ByteCollection, ByteIterable, ByteSet, ByteSortedSet, java.util.Collection<java.lang.Byte>, java.lang.Iterable<java.lang.Byte>, java.util.NavigableSet<java.lang.Byte>, java.util.Set<java.lang.Byte>, java.util.SortedSet<java.lang.Byte>

All Known Implementing Classes:

ByteAVLTreeSet, ByteRBTreeSet

public interface ByteNavigableSet
extends java.util.NavigableSet<java.lang.Byte>, ByteSortedSet

A Type Specific Navigable Set interface with a couple helper methods

Method Summary

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

Methods inherited from interface speiger.src.collections.bytes.sets.ByteSortedSet

comparator, firstByte, iterator, lastByte, pollFirstByte, pollLastByte

Methods inherited from interface speiger.src.collections.bytes.sets.ByteSet

add, contains, remByte, remove, remove

Methods inherited from interface speiger.src.collections.bytes.collections.ByteCollection

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

Methods inherited from interface speiger.src.collections.bytes.collections.ByteIterable

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

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

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

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

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

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

Parameters:

e - the new max value

getDefaultMaxValue

byte getDefaultMaxValue()

A Helper method to get the max value for SubSets.

Returns:

the default max value.

setDefaultMinValue

void setDefaultMinValue(byte e)

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

Parameters:

e - the new min value

getDefaultMinValue

byte getDefaultMinValue()

A Helper method to get the min value for SubSets.

Returns:

the default min value.

subSet

default ByteNavigableSet subSet(byte fromElement,
                                byte toElement)

Description copied from interface: ByteSortedSet

A Type Specific SubSet method to reduce boxing/unboxing

Specified by:

subSet in interface ByteSortedSet

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 ByteNavigableSet headSet(byte toElement)

Description copied from interface: ByteSortedSet

A Type Specific HeadSet method to reduce boxing/unboxing

Specified by:

headSet in interface ByteSortedSet

Parameters:

toElement - where the HeadSet should end

Returns:

a HeadSet that is within the range of the desired range

tailSet

default ByteNavigableSet tailSet(byte fromElement)

Description copied from interface: ByteSortedSet

A Type Specific TailSet method to reduce boxing/unboxing

Specified by:

tailSet in interface ByteSortedSet

Parameters:

fromElement - where the TailSet should start

Returns:

a TailSet that is within the range of the desired range

subSet

ByteNavigableSet subSet(byte fromElement,
                        boolean fromInclusive,
                        byte 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

ByteNavigableSet headSet(byte 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

ByteNavigableSet tailSet(byte 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

ByteBidirectionalIterator iterator()

Description copied from interface: ByteCollection

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

Specified by:

iterator in interface ByteCollection

Specified by:

iterator in interface ByteIterable

Specified by:

iterator in interface ByteSet

Specified by:

iterator in interface ByteSortedSet

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Returns:

a Type Specific iterator

See Also:

Collection.iterator()

descendingIterator

ByteBidirectionalIterator descendingIterator()

Specified by:

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

Returns:

a Type Specific desendingIterator

descendingSet

ByteNavigableSet descendingSet()

Specified by:

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

Returns:

a Type Specific desendingSet

copy

ByteNavigableSet copy()

Description copied from interface: ByteCollection

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 ByteCollection

Specified by:

copy in interface ByteSet

Specified by:

copy in interface ByteSortedSet

Returns:

a Shallow Copy of the collection

synchronize

default ByteNavigableSet synchronize()

Creates a Wrapped NavigableSet that is Synchronized

Specified by:

synchronize in interface ByteCollection

Specified by:

synchronize in interface ByteSet

Specified by:

synchronize in interface ByteSortedSet

Returns:

a new NavigableSet that is synchronized

See Also:

ByteSets.synchronize(speiger.src.collections.bytes.sets.ByteSet)

synchronize

default ByteNavigableSet synchronize(java.lang.Object mutex)

Creates a Wrapped NavigableSet that is Synchronized

Specified by:

synchronize in interface ByteCollection

Specified by:

synchronize in interface ByteSet

Specified by:

synchronize in interface ByteSortedSet

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableSet Wrapper that is synchronized

See Also:

ByteSets.synchronize(speiger.src.collections.bytes.sets.ByteSet)

unmodifiable

default ByteNavigableSet unmodifiable()

Creates a Wrapped NavigableSet that is unmodifiable

Specified by:

unmodifiable in interface ByteCollection

Specified by:

unmodifiable in interface ByteSet

Specified by:

unmodifiable in interface ByteSortedSet

Returns:

a new NavigableSet Wrapper that is unmodifiable

See Also:

ByteSets.unmodifiable(speiger.src.collections.bytes.sets.ByteSet)

spliterator

default ByteSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

spliterator in interface ByteCollection

Specified by:

spliterator in interface ByteIterable

Specified by:

spliterator in interface ByteSet

Specified by:

spliterator in interface ByteSortedSet

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Returns:

type specific splititerator

lower

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

Deprecated.

Specified by:

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

floor

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

Deprecated.

Specified by:

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

ceiling

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

Deprecated.

Specified by:

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

higher

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

Deprecated.

Specified by:

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

first

@Deprecated
default java.lang.Byte first()

Deprecated.

Specified by:

first in interface ByteSortedSet

Specified by:

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

last

@Deprecated
default java.lang.Byte last()

Deprecated.

Specified by:

last in interface ByteSortedSet

Specified by:

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

pollFirst

@Deprecated
default java.lang.Byte pollFirst()

Deprecated.

Specified by:

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

pollLast

@Deprecated
default java.lang.Byte pollLast()

Deprecated.

Specified by:

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

subSet

@Deprecated
default ByteNavigableSet subSet(java.lang.Byte fromElement,
                                             boolean fromInclusive,
                                             java.lang.Byte toElement,
                                             boolean toInclusive)

Deprecated.

Specified by:

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

headSet

@Deprecated
default ByteNavigableSet headSet(java.lang.Byte toElement,
                                              boolean inclusive)

Deprecated.

Specified by:

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

tailSet

@Deprecated
default ByteNavigableSet tailSet(java.lang.Byte fromElement,
                                              boolean inclusive)

Deprecated.

Specified by:

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

subSet

@Deprecated
default ByteSortedSet subSet(java.lang.Byte fromElement,
                                          java.lang.Byte toElement)

Deprecated.

Specified by:

subSet in interface ByteSortedSet

Specified by:

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

Specified by:

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

headSet

@Deprecated
default ByteSortedSet headSet(java.lang.Byte toElement)

Deprecated.

Specified by:

headSet in interface ByteSortedSet

Specified by:

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

Specified by:

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

tailSet

@Deprecated
default ByteSortedSet tailSet(java.lang.Byte fromElement)

Deprecated.

Specified by:

tailSet in interface ByteSortedSet

Specified by:

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

Specified by:

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