speiger.src.collections.longs.sets

Interface LongSortedSet

All Superinterfaces:

java.util.Collection<java.lang.Long>, java.lang.Iterable<java.lang.Long>, LongCollection, LongIterable, LongSet, java.util.Set<java.lang.Long>, java.util.SortedSet<java.lang.Long>

All Known Subinterfaces:

LongNavigableSet

All Known Implementing Classes:

LongAVLTreeSet, LongRBTreeSet

public interface LongSortedSet
extends LongSet, java.util.SortedSet<java.lang.Long>

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

Note:

LongOrderedSet is only extended until 0.6.0 for Compat reasons. The supported classes already implement LongOrderedSet directly and will remove LongSortedSet implementations in favor of LongOrderedSet instead

Method Summary

Modifier and Type	Method and Description
LongComparator	comparator() A Type Specific Comparator method
LongSortedSet	copy() A Function that does a shallow clone of the Collection itself.
default java.lang.Long	first() Deprecated.
long	firstLong() A method to get the first element in the set
LongSortedSet	headSet(long toElement) A Type Specific HeadSet method to reduce boxing/unboxing
default LongSortedSet	headSet(java.lang.Long toElement) Deprecated.
LongBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
LongBidirectionalIterator	iterator(long fromElement) A type Specific Iterator starting from a given key
default java.lang.Long	last() Deprecated.
long	lastLong() A method to get the last element in the set
long	pollFirstLong() A method to get and remove the first element in the set
long	pollLastLong() A method to get and remove the last element in the set
default LongSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
LongSortedSet	subSet(long fromElement, long toElement) A Type Specific SubSet method to reduce boxing/unboxing
default LongSortedSet	subSet(java.lang.Long fromElement, java.lang.Long toElement) Deprecated.
default LongSortedSet	synchronize() Creates a Wrapped SortedSet that is Synchronized
default LongSortedSet	synchronize(java.lang.Object mutex) Creates a Wrapped SortedSet that is Synchronized
LongSortedSet	tailSet(long fromElement) A Type Specific TailSet method to reduce boxing/unboxing
default LongSortedSet	tailSet(java.lang.Long fromElement) Deprecated.
default LongSortedSet	unmodifiable() Creates a Wrapped SortedSet that is unmodifiable

Methods inherited from interface speiger.src.collections.longs.sets.LongSet

add, contains, remLong, remove, remove

Methods inherited from interface speiger.src.collections.longs.collections.LongCollection

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

Methods inherited from interface speiger.src.collections.longs.collections.LongIterable

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

comparator

LongComparator comparator()

A Type Specific Comparator method

Specified by:

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

Returns:

the type specific comparator

copy

LongSortedSet copy()

Description copied from interface: LongCollection

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 LongCollection

Specified by:

copy in interface LongSet

Returns:

a Shallow Copy of the collection

iterator

LongBidirectionalIterator iterator()

Description copied from interface: LongCollection

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface LongCollection

Specified by:

iterator in interface LongIterable

Specified by:

iterator in interface LongSet

Specified by:

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

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

LongBidirectionalIterator iterator(long 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

synchronize

default LongSortedSet synchronize()

Creates a Wrapped SortedSet that is Synchronized

Specified by:

synchronize in interface LongCollection

Specified by:

synchronize in interface LongSet

Returns:

a new SortedSet that is synchronized

See Also:

LongSets.synchronize(speiger.src.collections.longs.sets.LongSet)

synchronize

default LongSortedSet synchronize(java.lang.Object mutex)

Creates a Wrapped SortedSet that is Synchronized

Specified by:

synchronize in interface LongCollection

Specified by:

synchronize in interface LongSet

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedSet Wrapper that is synchronized

See Also:

LongSets.synchronize(speiger.src.collections.longs.sets.LongSet)

unmodifiable

default LongSortedSet unmodifiable()

Creates a Wrapped SortedSet that is unmodifiable

Specified by:

unmodifiable in interface LongCollection

Specified by:

unmodifiable in interface LongSet

Returns:

a new SortedSet Wrapper that is unmodifiable

See Also:

LongSets.unmodifiable(speiger.src.collections.longs.sets.LongSet)

spliterator

default LongSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

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

Specified by:

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

Specified by:

spliterator in interface LongCollection

Specified by:

spliterator in interface LongIterable

Specified by:

spliterator in interface LongSet

Specified by:

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

Specified by:

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

Returns:

type specific splititerator

subSet

LongSortedSet subSet(long fromElement,
                     long 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

LongSortedSet headSet(long 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

LongSortedSet tailSet(long 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.

firstLong

long firstLong()

A method to get the first element in the set

Returns:

first element in the set

pollFirstLong

long pollFirstLong()

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

Returns:

first element in the set

lastLong

long lastLong()

A method to get the last element in the set

Returns:

last element in the set

pollLastLong

long pollLastLong()

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

Returns:

last element in the set

subSet

@Deprecated
default LongSortedSet subSet(java.lang.Long fromElement,
                                          java.lang.Long toElement)

Deprecated.

Specified by:

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

headSet

@Deprecated
default LongSortedSet headSet(java.lang.Long toElement)

Deprecated.

Specified by:

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

tailSet

@Deprecated
default LongSortedSet tailSet(java.lang.Long fromElement)

Deprecated.

Specified by:

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

first

@Deprecated
default java.lang.Long first()

Deprecated.

Specified by:

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

last

@Deprecated
default java.lang.Long last()

Deprecated.

Specified by:

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