speiger.src.collections.objects.sets

Interface ObjectNavigableSet<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Superinterfaces:

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

All Known Implementing Classes:

ObjectAVLTreeSet, ObjectRBTreeSet

public interface ObjectNavigableSet<T>
extends java.util.NavigableSet<T>, ObjectSortedSet<T>

A Type Specific Navigable Set interface with a couple helper methods

Method Summary

Modifier and Type	Method and Description
ObjectNavigableSet<T>	copy() A Function that does a shallow clone of the Collection itself.
ObjectBidirectionalIterator<T>	descendingIterator()
ObjectNavigableSet<T>	descendingSet()
default ObjectNavigableSet<T>	headSet(T toElement)
ObjectNavigableSet<T>	headSet(T toElement, boolean inclusive)
ObjectBidirectionalIterator<T>	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
default ObjectSplititerator<T>	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
ObjectNavigableSet<T>	subSet(T fromElement, boolean fromInclusive, T toElement, boolean toInclusive)
default ObjectNavigableSet<T>	subSet(T fromElement, T toElement)
default ObjectNavigableSet<T>	synchronize() Creates a Wrapped NavigableSet that is Synchronized
default ObjectNavigableSet<T>	synchronize(java.lang.Object mutex) Creates a Wrapped NavigableSet that is Synchronized
default ObjectNavigableSet<T>	tailSet(T fromElement)
ObjectNavigableSet<T>	tailSet(T fromElement, boolean inclusive)
default ObjectNavigableSet<T>	unmodifiable() Creates a Wrapped NavigableSet that is unmodifiable

Methods inherited from interface java.util.NavigableSet

ceiling, floor, higher, lower, pollFirst, pollLast

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

comparator, iterator, pollFirst, pollLast

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, limit, map, matchesAll, matchesAny, matchesNone, peek, pourAsList, pourAsSet, reduce, reduce, sorted

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

subSet

default ObjectNavigableSet<T> subSet(T fromElement,
                                     T toElement)

Specified by:

subSet in interface java.util.NavigableSet<T>

Specified by:

subSet in interface ObjectSortedSet<T>

Specified by:

subSet in interface java.util.SortedSet<T>

headSet

default ObjectNavigableSet<T> headSet(T toElement)

Specified by:

headSet in interface java.util.NavigableSet<T>

Specified by:

headSet in interface ObjectSortedSet<T>

Specified by:

headSet in interface java.util.SortedSet<T>

tailSet

default ObjectNavigableSet<T> tailSet(T fromElement)

Specified by:

tailSet in interface java.util.NavigableSet<T>

Specified by:

tailSet in interface ObjectSortedSet<T>

Specified by:

tailSet in interface java.util.SortedSet<T>

subSet

ObjectNavigableSet<T> subSet(T fromElement,
                             boolean fromInclusive,
                             T toElement,
                             boolean toInclusive)

Specified by:

subSet in interface java.util.NavigableSet<T>

headSet

ObjectNavigableSet<T> headSet(T toElement,
                              boolean inclusive)

Specified by:

headSet in interface java.util.NavigableSet<T>

tailSet

ObjectNavigableSet<T> tailSet(T fromElement,
                              boolean inclusive)

Specified by:

tailSet in interface java.util.NavigableSet<T>

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 java.util.NavigableSet<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 ObjectSortedSet<T>

Specified by:

iterator in interface java.util.Set<T>

Returns:

a Type Specific iterator

See Also:

Collection.iterator()

descendingIterator

ObjectBidirectionalIterator<T> descendingIterator()

Specified by:

descendingIterator in interface java.util.NavigableSet<T>

Returns:

a Type Specific desendingIterator

descendingSet

ObjectNavigableSet<T> descendingSet()

Specified by:

descendingSet in interface java.util.NavigableSet<T>

Returns:

a Type Specific desendingSet

copy

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

Specified by:

copy in interface ObjectSortedSet<T>

Returns:

a Shallow Copy of the collection

synchronize

default ObjectNavigableSet<T> synchronize()

Creates a Wrapped NavigableSet that is Synchronized

Specified by:

synchronize in interface ObjectCollection<T>

Specified by:

synchronize in interface ObjectSet<T>

Specified by:

synchronize in interface ObjectSortedSet<T>

Returns:

a new NavigableSet that is synchronized

See Also:

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

synchronize

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

Creates a Wrapped NavigableSet that is Synchronized

Specified by:

synchronize in interface ObjectCollection<T>

Specified by:

synchronize in interface ObjectSet<T>

Specified by:

synchronize in interface ObjectSortedSet<T>

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableSet Wrapper that is synchronized

See Also:

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

unmodifiable

default ObjectNavigableSet<T> unmodifiable()

Creates a Wrapped NavigableSet that is unmodifiable

Specified by:

unmodifiable in interface ObjectCollection<T>

Specified by:

unmodifiable in interface ObjectSet<T>

Specified by:

unmodifiable in interface ObjectSortedSet<T>

Returns:

a new NavigableSet 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 ObjectSortedSet<T>

Specified by:

spliterator in interface java.util.Set<T>

Specified by:

spliterator in interface java.util.SortedSet<T>

Returns:

type specific splititerator