speiger.src.collections.chars.sets

Interface CharNavigableSet

All Superinterfaces:

CharCollection, CharIterable, CharSet, CharSortedSet, java.util.Collection<java.lang.Character>, java.lang.Iterable<java.lang.Character>, java.util.NavigableSet<java.lang.Character>, java.util.Set<java.lang.Character>, java.util.SortedSet<java.lang.Character>

All Known Implementing Classes:

CharAVLTreeSet, CharRBTreeSet

public interface CharNavigableSet
extends java.util.NavigableSet<java.lang.Character>, CharSortedSet

A Type Specific Navigable Set interface with a couple helper methods

Method Summary

Modifier and Type	Method and Description
char	ceiling(char key) A Type Specific ceiling method to reduce boxing/unboxing.
default java.lang.Character	ceiling(java.lang.Character e) Deprecated.
CharBidirectionalIterator	descendingIterator()
CharNavigableSet	descendingSet()
default java.lang.Character	first() Deprecated.
char	floor(char key) A Type Specific floor method to reduce boxing/unboxing.
default java.lang.Character	floor(java.lang.Character e) Deprecated.
char	getDefaultMaxValue() A Helper method to get the max value for SubSets.
char	getDefaultMinValue() A Helper method to get the min value for SubSets.
default CharNavigableSet	headSet(char toElement) A Type Specific HeadSet method to reduce boxing/unboxing
default CharSortedSet	headSet(java.lang.Character toElement) Deprecated.
default CharNavigableSet	headSet(java.lang.Character toElement, boolean inclusive) Deprecated.
CharNavigableSet	headSet(char toElement, boolean inclusive) A Type Specific HeadSet method to reduce boxing/unboxing
char	higher(char key) A Type Specific higher method to reduce boxing/unboxing.
default java.lang.Character	higher(java.lang.Character e) Deprecated.
CharBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
default java.lang.Character	last() Deprecated.
char	lower(char key) A Type Specific lower method to reduce boxing/unboxing.
default java.lang.Character	lower(java.lang.Character e) Deprecated.
default java.lang.Character	pollFirst() Deprecated.
default java.lang.Character	pollLast() Deprecated.
void	setDefaultMaxValue(char e) A Helper method to set the max value for SubSets.
void	setDefaultMinValue(char e) A Helper method to set the min value for SubSets.
default CharSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
default CharNavigableSet	subSet(java.lang.Character fromElement, boolean fromInclusive, java.lang.Character toElement, boolean toInclusive) Deprecated.
default CharSortedSet	subSet(java.lang.Character fromElement, java.lang.Character toElement) Deprecated.
CharNavigableSet	subSet(char fromElement, boolean fromInclusive, char toElement, boolean toInclusive) A Type Specific SubSet method to reduce boxing/unboxing
default CharNavigableSet	subSet(char fromElement, char toElement) A Type Specific SubSet method to reduce boxing/unboxing
default CharNavigableSet	tailSet(char fromElement) A Type Specific TailSet method to reduce boxing/unboxing
default CharSortedSet	tailSet(java.lang.Character fromElement) Deprecated.
default CharNavigableSet	tailSet(java.lang.Character fromElement, boolean inclusive) Deprecated.
CharNavigableSet	tailSet(char fromElement, boolean inclusive) A Type Specific TailSet method to reduce boxing/unboxing

Methods inherited from interface speiger.src.collections.chars.sets.CharSortedSet

addAndMoveToFirst, addAndMoveToLast, comparator, firstChar, iterator, lastChar, moveToFirst, moveToLast, pollFirstChar, pollLastChar

Methods inherited from interface speiger.src.collections.chars.sets.CharSet

add, contains, remChar, remove, remove

Methods inherited from interface speiger.src.collections.chars.collections.CharCollection

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

Methods inherited from interface speiger.src.collections.chars.collections.CharIterable

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

lower

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

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

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

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

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

Parameters:

e - the new max value

getDefaultMaxValue

char getDefaultMaxValue()

A Helper method to get the max value for SubSets.

Returns:

the default max value.

setDefaultMinValue

void setDefaultMinValue(char e)

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

Parameters:

e - the new min value

getDefaultMinValue

char getDefaultMinValue()

A Helper method to get the min value for SubSets.

Returns:

the default min value.

subSet

default CharNavigableSet subSet(char fromElement,
                                char toElement)

Description copied from interface: CharSortedSet

A Type Specific SubSet method to reduce boxing/unboxing

Specified by:

subSet in interface CharSortedSet

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 CharNavigableSet headSet(char toElement)

Description copied from interface: CharSortedSet

A Type Specific HeadSet method to reduce boxing/unboxing

Specified by:

headSet in interface CharSortedSet

Parameters:

toElement - where the HeadSet should end

Returns:

a HeadSet that is within the range of the desired range

tailSet

default CharNavigableSet tailSet(char fromElement)

Description copied from interface: CharSortedSet

A Type Specific TailSet method to reduce boxing/unboxing

Specified by:

tailSet in interface CharSortedSet

Parameters:

fromElement - where the TailSet should start

Returns:

a TailSet that is within the range of the desired range

subSet

CharNavigableSet subSet(char fromElement,
                        boolean fromInclusive,
                        char 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

CharNavigableSet headSet(char 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

CharNavigableSet tailSet(char 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

CharBidirectionalIterator iterator()

Description copied from interface: CharCollection

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

Specified by:

iterator in interface CharCollection

Specified by:

iterator in interface CharIterable

Specified by:

iterator in interface CharSet

Specified by:

iterator in interface CharSortedSet

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Returns:

a Type Specific iterator

See Also:

Collection.iterator()

descendingIterator

CharBidirectionalIterator descendingIterator()

Specified by:

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

Returns:

a Type Specific desendingIterator

descendingSet

CharNavigableSet descendingSet()

Specified by:

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

Returns:

a Type Specific desendingSet

spliterator

default CharSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

spliterator in interface CharCollection

Specified by:

spliterator in interface CharIterable

Specified by:

spliterator in interface CharSet

Specified by:

spliterator in interface CharSortedSet

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Returns:

type specific splititerator

lower

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

Deprecated.

Specified by:

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

floor

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

Deprecated.

Specified by:

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

ceiling

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

Deprecated.

Specified by:

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

higher

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

Deprecated.

Specified by:

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

first

@Deprecated
default java.lang.Character first()

Deprecated.

Specified by:

first in interface CharSortedSet

Specified by:

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

last

@Deprecated
default java.lang.Character last()

Deprecated.

Specified by:

last in interface CharSortedSet

Specified by:

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

pollFirst

@Deprecated
default java.lang.Character pollFirst()

Deprecated.

Specified by:

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

pollLast

@Deprecated
default java.lang.Character pollLast()

Deprecated.

Specified by:

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

subSet

@Deprecated
default CharNavigableSet subSet(java.lang.Character fromElement,
                                             boolean fromInclusive,
                                             java.lang.Character toElement,
                                             boolean toInclusive)

Deprecated.

Specified by:

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

headSet

@Deprecated
default CharNavigableSet headSet(java.lang.Character toElement,
                                              boolean inclusive)

Deprecated.

Specified by:

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

tailSet

@Deprecated
default CharNavigableSet tailSet(java.lang.Character fromElement,
                                              boolean inclusive)

Deprecated.

Specified by:

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

subSet

@Deprecated
default CharSortedSet subSet(java.lang.Character fromElement,
                                          java.lang.Character toElement)

Deprecated.

Specified by:

subSet in interface CharSortedSet

Specified by:

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

Specified by:

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

headSet

@Deprecated
default CharSortedSet headSet(java.lang.Character toElement)

Deprecated.

Specified by:

headSet in interface CharSortedSet

Specified by:

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

Specified by:

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

tailSet

@Deprecated
default CharSortedSet tailSet(java.lang.Character fromElement)

Deprecated.

Specified by:

tailSet in interface CharSortedSet

Specified by:

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

Specified by:

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