speiger.src.collections.chars.sets

Interface CharSortedSet

All Superinterfaces:

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

All Known Subinterfaces:

CharNavigableSet

All Known Implementing Classes:

CharArraySet, CharAVLTreeSet, CharLinkedOpenCustomHashSet, CharLinkedOpenHashSet, CharRBTreeSet

public interface CharSortedSet
extends CharSet, java.util.SortedSet<java.lang.Character>

A Type Specific SortedSet implementation to reduce boxing/unboxing with a couple extra methods that allow greater control over sets.

Method Summary

Modifier and Type	Method and Description
boolean	addAndMoveToFirst(char o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(char o) A customized add method that allows you to insert into the last index.
CharComparator	comparator() A Type Specific Comparator method
default java.lang.Character	first() Deprecated.
char	firstChar() A method to get the first element in the set
CharSortedSet	headSet(char toElement) A Type Specific HeadSet method to reduce boxing/unboxing
default CharSortedSet	headSet(java.lang.Character toElement) Deprecated.
CharBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
CharBidirectionalIterator	iterator(char fromElement) A type Specific Iterator starting from a given key
default java.lang.Character	last() Deprecated.
char	lastChar() A method to get the last element in the set
boolean	moveToFirst(char o) A specific move method to move a given key to the first index.
boolean	moveToLast(char o) A specific move method to move a given key to the last index.
char	pollFirstChar() A method to get and remove the first element in the set
char	pollLastChar() A method to get and remove the last element in the set
default CharSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
default CharSortedSet	subSet(java.lang.Character fromElement, java.lang.Character toElement) Deprecated.
CharSortedSet	subSet(char fromElement, char toElement) A Type Specific SubSet method to reduce boxing/unboxing
CharSortedSet	tailSet(char fromElement) A Type Specific TailSet method to reduce boxing/unboxing
default CharSortedSet	tailSet(java.lang.Character fromElement) Deprecated.

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

addAndMoveToFirst

boolean addAndMoveToFirst(char o)

A customized add method that allows you to insert into the first index.

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

Note:

some implementations do not support this method

addAndMoveToLast

boolean addAndMoveToLast(char o)

A customized add method that allows you to insert into the last index.

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

Note:

some implementations do not support this method

moveToFirst

boolean moveToFirst(char o)

A specific move method to move a given key to the first index.

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place, some implementations do not support this method

moveToLast

boolean moveToLast(char o)

A specific move method to move a given key to the last index.

Parameters:

o - that should be moved to the first last

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place, some implementations do not support this method

comparator

CharComparator comparator()

A Type Specific Comparator method

Specified by:

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

Returns:

the type specific comparator

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 java.util.Collection<java.lang.Character>

Specified by:

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

Specified by:

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

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

CharBidirectionalIterator iterator(char 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

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

subSet

CharSortedSet subSet(char fromElement,
                     char 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

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

CharSortedSet tailSet(char 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.

firstChar

char firstChar()

A method to get the first element in the set

Returns:

first element in the set

pollFirstChar

char pollFirstChar()

A method to get and remove the first element in the set

Returns:

first element in the set

lastChar

char lastChar()

A method to get the last element in the set

Returns:

last element in the set

pollLastChar

char pollLastChar()

A method to get and remove the last element in the set

Returns:

last element in the set

subSet

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

Deprecated.

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 java.util.SortedSet<java.lang.Character>

tailSet

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

Deprecated.

Specified by:

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

first

@Deprecated
default java.lang.Character first()

Deprecated.

Specified by:

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

last

@Deprecated
default java.lang.Character last()

Deprecated.

Specified by:

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