speiger.src.collections.bytes.sets

Interface ByteSortedSet

All Superinterfaces:

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

All Known Subinterfaces:

ByteNavigableSet

All Known Implementing Classes:

ByteArraySet, ByteAVLTreeSet, ByteLinkedOpenCustomHashSet, ByteLinkedOpenHashSet, ByteRBTreeSet

public interface ByteSortedSet
extends ByteSet, java.util.SortedSet<java.lang.Byte>

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(byte o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(byte o) A customized add method that allows you to insert into the last index.
ByteComparator	comparator() A Type Specific Comparator method
default java.lang.Byte	first() Deprecated.
byte	firstByte() A method to get the first element in the set
ByteSortedSet	headSet(byte toElement) A Type Specific HeadSet method to reduce boxing/unboxing
default ByteSortedSet	headSet(java.lang.Byte toElement) Deprecated.
ByteBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
ByteBidirectionalIterator	iterator(byte fromElement) A type Specific Iterator starting from a given key
default java.lang.Byte	last() Deprecated.
byte	lastByte() A method to get the last element in the set
boolean	moveToFirst(byte o) A specific move method to move a given key to the first index.
boolean	moveToLast(byte o) A specific move method to move a given key to the last index.
byte	pollFirstByte() A method to get and remove the first element in the set
byte	pollLastByte() A method to get and remove the last element in the set
default ByteSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
ByteSortedSet	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.
ByteSortedSet	tailSet(byte fromElement) A Type Specific TailSet method to reduce boxing/unboxing
default ByteSortedSet	tailSet(java.lang.Byte fromElement) Deprecated.

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, contains, containsAll, containsAny, containsAny, parallelPrimitiveStream, primitiveStream, remIf, removeAll, removeIf, retainAll, toByteArray, toByteArray

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

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

ByteComparator comparator()

A Type Specific Comparator method

Specified by:

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

Returns:

the type specific comparator

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

Specified by:

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

Specified by:

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

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

ByteBidirectionalIterator iterator(byte 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 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 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

subSet

ByteSortedSet subSet(byte fromElement,
                     byte 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

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

ByteSortedSet tailSet(byte 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.

firstByte

byte firstByte()

A method to get the first element in the set

Returns:

first element in the set

pollFirstByte

byte pollFirstByte()

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

Returns:

first element in the set

lastByte

byte lastByte()

A method to get the last element in the set

Returns:

last element in the set

pollLastByte

byte pollLastByte()

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

Returns:

last element in the set

subSet

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

Deprecated.

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

tailSet

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

Deprecated.

Specified by:

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

first

@Deprecated
default java.lang.Byte first()

Deprecated.

Specified by:

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

last

@Deprecated
default java.lang.Byte last()

Deprecated.

Specified by:

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