speiger.src.collections.objects.sets

Interface ObjectSortedSet<T>

Type Parameters:

T - the keyType of elements maintained by this Collection

All Superinterfaces:

java.util.Collection<T>, ISizeProvider, java.lang.Iterable<T>, ObjectCollection<T>, ObjectIterable<T>, ObjectSet<T>, java.util.Set<T>, java.util.SortedSet<T>

All Known Subinterfaces:

Byte2BooleanSortedMap.FastSortedSet, Byte2ByteSortedMap.FastSortedSet, Byte2CharSortedMap.FastSortedSet, Byte2DoubleSortedMap.FastSortedSet, Byte2FloatSortedMap.FastSortedSet, Byte2IntSortedMap.FastSortedSet, Byte2LongSortedMap.FastSortedSet, Byte2ObjectSortedMap.FastSortedSet<V>, Byte2ShortSortedMap.FastSortedSet, Char2BooleanSortedMap.FastSortedSet, Char2ByteSortedMap.FastSortedSet, Char2CharSortedMap.FastSortedSet, Char2DoubleSortedMap.FastSortedSet, Char2FloatSortedMap.FastSortedSet, Char2IntSortedMap.FastSortedSet, Char2LongSortedMap.FastSortedSet, Char2ObjectSortedMap.FastSortedSet<V>, Char2ShortSortedMap.FastSortedSet, Double2BooleanSortedMap.FastSortedSet, Double2ByteSortedMap.FastSortedSet, Double2CharSortedMap.FastSortedSet, Double2DoubleSortedMap.FastSortedSet, Double2FloatSortedMap.FastSortedSet, Double2IntSortedMap.FastSortedSet, Double2LongSortedMap.FastSortedSet, Double2ObjectSortedMap.FastSortedSet<V>, Double2ShortSortedMap.FastSortedSet, Float2BooleanSortedMap.FastSortedSet, Float2ByteSortedMap.FastSortedSet, Float2CharSortedMap.FastSortedSet, Float2DoubleSortedMap.FastSortedSet, Float2FloatSortedMap.FastSortedSet, Float2IntSortedMap.FastSortedSet, Float2LongSortedMap.FastSortedSet, Float2ObjectSortedMap.FastSortedSet<V>, Float2ShortSortedMap.FastSortedSet, Int2BooleanSortedMap.FastSortedSet, Int2ByteSortedMap.FastSortedSet, Int2CharSortedMap.FastSortedSet, Int2DoubleSortedMap.FastSortedSet, Int2FloatSortedMap.FastSortedSet, Int2IntSortedMap.FastSortedSet, Int2LongSortedMap.FastSortedSet, Int2ObjectSortedMap.FastSortedSet<V>, Int2ShortSortedMap.FastSortedSet, Long2BooleanSortedMap.FastSortedSet, Long2ByteSortedMap.FastSortedSet, Long2CharSortedMap.FastSortedSet, Long2DoubleSortedMap.FastSortedSet, Long2FloatSortedMap.FastSortedSet, Long2IntSortedMap.FastSortedSet, Long2LongSortedMap.FastSortedSet, Long2ObjectSortedMap.FastSortedSet<V>, Long2ShortSortedMap.FastSortedSet, Object2BooleanSortedMap.FastSortedSet<T>, Object2ByteSortedMap.FastSortedSet<T>, Object2CharSortedMap.FastSortedSet<T>, Object2DoubleSortedMap.FastSortedSet<T>, Object2FloatSortedMap.FastSortedSet<T>, Object2IntSortedMap.FastSortedSet<T>, Object2LongSortedMap.FastSortedSet<T>, Object2ObjectSortedMap.FastSortedSet<T,V>, Object2ShortSortedMap.FastSortedSet<T>, ObjectNavigableSet<T>, Short2BooleanSortedMap.FastSortedSet, Short2ByteSortedMap.FastSortedSet, Short2CharSortedMap.FastSortedSet, Short2DoubleSortedMap.FastSortedSet, Short2FloatSortedMap.FastSortedSet, Short2IntSortedMap.FastSortedSet, Short2LongSortedMap.FastSortedSet, Short2ObjectSortedMap.FastSortedSet<V>, Short2ShortSortedMap.FastSortedSet

All Known Implementing Classes:

ObjectAVLTreeSet, ObjectRBTreeSet

public interface ObjectSortedSet<T>
extends ObjectSet<T>, java.util.SortedSet<T>

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

Note:

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

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.utils.ISizeProvider

ISizeProvider.CollectionSize

Method Summary

Modifier and Type	Method and Description
java.util.Comparator<T>	comparator() A Type Specific Comparator method
ObjectSortedSet<T>	copy() A Function that does a shallow clone of the Collection itself.
ObjectSortedSet<T>	headSet(T toElement)
ObjectBidirectionalIterator<T>	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
ObjectBidirectionalIterator<T>	iterator(T fromElement) A type Specific Iterator starting from a given key
T	pollFirst() A method to get and remove the first element in the set
T	pollLast() A method to get and remove the last element in the set
default ObjectSplititerator<T>	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
ObjectSortedSet<T>	subSet(T fromElement, T toElement)
default ObjectSortedSet<T>	synchronize() Creates a Wrapped SortedSet that is Synchronized
default ObjectSortedSet<T>	synchronize(java.lang.Object mutex) Creates a Wrapped SortedSet that is Synchronized
ObjectSortedSet<T>	tailSet(T fromElement)
default ObjectSortedSet<T>	unmodifiable() Creates a Wrapped SortedSet that is unmodifiable

Methods inherited from interface speiger.src.collections.objects.sets.ObjectSet

addOrGet

Methods inherited from interface speiger.src.collections.objects.collections.ObjectCollection

addAll, addAll, addAll, addAll, containsAll, containsAny, containsAny, pour, removeAll, removeAll, retainAll, retainAll, toArray

Methods inherited from interface speiger.src.collections.objects.collections.ObjectIterable

arrayflatMap, asAsync, count, distinct, filter, findFirst, flatMap, forEach, forEachIndexed, limit, map, matchesAll, matchesAny, matchesNone, peek, pourAsList, pourAsSet, reduce, reduce, repeat, sorted

Methods inherited from interface speiger.src.collections.utils.ISizeProvider

of, size

Methods inherited from interface java.util.SortedSet

first, last

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

comparator

java.util.Comparator<T> comparator()

A Type Specific Comparator method

Specified by:

comparator in interface java.util.SortedSet<T>

Returns:

the type specific comparator

copy

ObjectSortedSet<T> copy()

Description copied from interface: ObjectCollection

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

Specified by:

copy in interface ObjectSet<T>

Returns:

a Shallow Copy of the collection

iterator

ObjectBidirectionalIterator<T> iterator()

Description copied from interface: ObjectCollection

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

Specified by:

iterator in interface java.util.Collection<T>

Specified by:

iterator in interface java.lang.Iterable<T>

Specified by:

iterator in interface ObjectCollection<T>

Specified by:

iterator in interface ObjectIterable<T>

Specified by:

iterator in interface ObjectSet<T>

Specified by:

iterator in interface java.util.Set<T>

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

ObjectBidirectionalIterator<T> iterator(T 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 ObjectSortedSet<T> synchronize()

Creates a Wrapped SortedSet that is Synchronized

Specified by:

synchronize in interface ObjectCollection<T>

Specified by:

synchronize in interface ObjectSet<T>

Returns:

a new SortedSet that is synchronized

See Also:

ObjectSets.synchronize(speiger.src.collections.objects.sets.ObjectSet<T>)

synchronize

default ObjectSortedSet<T> synchronize(java.lang.Object mutex)

Creates a Wrapped SortedSet that is Synchronized

Specified by:

synchronize in interface ObjectCollection<T>

Specified by:

synchronize in interface ObjectSet<T>

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedSet Wrapper that is synchronized

See Also:

ObjectSets.synchronize(speiger.src.collections.objects.sets.ObjectSet<T>)

unmodifiable

default ObjectSortedSet<T> unmodifiable()

Creates a Wrapped SortedSet that is unmodifiable

Specified by:

unmodifiable in interface ObjectCollection<T>

Specified by:

unmodifiable in interface ObjectSet<T>

Returns:

a new SortedSet Wrapper that is unmodifiable

See Also:

ObjectSets.unmodifiable(speiger.src.collections.objects.sets.ObjectSet<T>)

spliterator

default ObjectSplititerator<T> spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

spliterator in interface java.util.Collection<T>

Specified by:

spliterator in interface java.lang.Iterable<T>

Specified by:

spliterator in interface ObjectCollection<T>

Specified by:

spliterator in interface ObjectIterable<T>

Specified by:

spliterator in interface ObjectSet<T>

Specified by:

spliterator in interface java.util.Set<T>

Specified by:

spliterator in interface java.util.SortedSet<T>

Returns:

type specific splititerator

pollFirst

T pollFirst()

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

Returns:

first element in the set

pollLast

T pollLast()

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

Returns:

last element in the set

subSet

ObjectSortedSet<T> subSet(T fromElement,
                          T toElement)

Specified by:

subSet in interface java.util.SortedSet<T>

headSet

ObjectSortedSet<T> headSet(T toElement)

Specified by:

headSet in interface java.util.SortedSet<T>

tailSet

ObjectSortedSet<T> tailSet(T fromElement)

Specified by:

tailSet in interface java.util.SortedSet<T>