speiger.src.collections.ints.sets

Interface IntSortedSet

All Superinterfaces:

java.util.Collection<java.lang.Integer>, IntCollection, IntIterable, IntSet, java.lang.Iterable<java.lang.Integer>, java.util.Set<java.lang.Integer>, java.util.SortedSet<java.lang.Integer>

All Known Subinterfaces:

IntNavigableSet

All Known Implementing Classes:

IntAVLTreeSet, IntRBTreeSet

public interface IntSortedSet
extends IntSet, java.util.SortedSet<java.lang.Integer>

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

Note:

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

Method Summary

Modifier and Type	Method and Description
IntComparator	comparator() A Type Specific Comparator method
IntSortedSet	copy() A Function that does a shallow clone of the Collection itself.
default java.lang.Integer	first() Deprecated.
int	firstInt() A method to get the first element in the set
IntSortedSet	headSet(int toElement) A Type Specific HeadSet method to reduce boxing/unboxing
default IntSortedSet	headSet(java.lang.Integer toElement) Deprecated.
IntBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
IntBidirectionalIterator	iterator(int fromElement) A type Specific Iterator starting from a given key
default java.lang.Integer	last() Deprecated.
int	lastInt() A method to get the last element in the set
int	pollFirstInt() A method to get and remove the first element in the set
int	pollLastInt() A method to get and remove the last element in the set
default IntSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
default IntSortedSet	subSet(java.lang.Integer fromElement, java.lang.Integer toElement) Deprecated.
IntSortedSet	subSet(int fromElement, int toElement) A Type Specific SubSet method to reduce boxing/unboxing
default IntSortedSet	synchronize() Creates a Wrapped SortedSet that is Synchronized
default IntSortedSet	synchronize(java.lang.Object mutex) Creates a Wrapped SortedSet that is Synchronized
IntSortedSet	tailSet(int fromElement) A Type Specific TailSet method to reduce boxing/unboxing
default IntSortedSet	tailSet(java.lang.Integer fromElement) Deprecated.
default IntSortedSet	unmodifiable() Creates a Wrapped SortedSet that is unmodifiable

Methods inherited from interface speiger.src.collections.ints.sets.IntSet

add, contains, remInt, remove, remove

Methods inherited from interface speiger.src.collections.ints.collections.IntCollection

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

Methods inherited from interface speiger.src.collections.ints.collections.IntIterable

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

IntComparator comparator()

A Type Specific Comparator method

Specified by:

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

Returns:

the type specific comparator

copy

IntSortedSet copy()

Description copied from interface: IntCollection

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 IntCollection

Specified by:

copy in interface IntSet

Returns:

a Shallow Copy of the collection

iterator

IntBidirectionalIterator iterator()

Description copied from interface: IntCollection

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

Specified by:

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

Specified by:

iterator in interface IntCollection

Specified by:

iterator in interface IntIterable

Specified by:

iterator in interface IntSet

Specified by:

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

Specified by:

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

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

IntBidirectionalIterator iterator(int 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 IntSortedSet synchronize()

Creates a Wrapped SortedSet that is Synchronized

Specified by:

synchronize in interface IntCollection

Specified by:

synchronize in interface IntSet

Returns:

a new SortedSet that is synchronized

See Also:

IntSets.synchronize(speiger.src.collections.ints.sets.IntSet)

synchronize

default IntSortedSet synchronize(java.lang.Object mutex)

Creates a Wrapped SortedSet that is Synchronized

Specified by:

synchronize in interface IntCollection

Specified by:

synchronize in interface IntSet

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedSet Wrapper that is synchronized

See Also:

IntSets.synchronize(speiger.src.collections.ints.sets.IntSet)

unmodifiable

default IntSortedSet unmodifiable()

Creates a Wrapped SortedSet that is unmodifiable

Specified by:

unmodifiable in interface IntCollection

Specified by:

unmodifiable in interface IntSet

Returns:

a new SortedSet Wrapper that is unmodifiable

See Also:

IntSets.unmodifiable(speiger.src.collections.ints.sets.IntSet)

spliterator

default IntSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

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

Specified by:

spliterator in interface IntCollection

Specified by:

spliterator in interface IntIterable

Specified by:

spliterator in interface IntSet

Specified by:

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

Specified by:

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

Specified by:

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

Returns:

type specific splititerator

subSet

IntSortedSet subSet(int fromElement,
                    int 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

IntSortedSet headSet(int 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

IntSortedSet tailSet(int 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.

firstInt

int firstInt()

A method to get the first element in the set

Returns:

first element in the set

pollFirstInt

int pollFirstInt()

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

Returns:

first element in the set

lastInt

int lastInt()

A method to get the last element in the set

Returns:

last element in the set

pollLastInt

int pollLastInt()

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

Returns:

last element in the set

subSet

@Deprecated
default IntSortedSet subSet(java.lang.Integer fromElement,
                                         java.lang.Integer toElement)

Deprecated.

Specified by:

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

headSet

@Deprecated
default IntSortedSet headSet(java.lang.Integer toElement)

Deprecated.

Specified by:

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

tailSet

@Deprecated
default IntSortedSet tailSet(java.lang.Integer fromElement)

Deprecated.

Specified by:

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

first

@Deprecated
default java.lang.Integer first()

Deprecated.

Specified by:

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

last

@Deprecated
default java.lang.Integer last()

Deprecated.

Specified by:

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