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:

IntArraySet, IntAVLTreeSet, IntLinkedOpenCustomHashSet, IntLinkedOpenHashSet, 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.

Method Summary

Modifier and Type	Method and Description
boolean	addAndMoveToFirst(int o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(int o) A customized add method that allows you to insert into the last index.
IntComparator	comparator() A Type Specific Comparator method
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
boolean	moveToFirst(int o) A specific move method to move a given key to the first index.
boolean	moveToLast(int o) A specific move method to move a given key to the last index.
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
IntSortedSet	tailSet(int fromElement) A Type Specific TailSet method to reduce boxing/unboxing
default IntSortedSet	tailSet(java.lang.Integer fromElement) Deprecated.

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

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

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

IntComparator comparator()

A Type Specific Comparator method

Specified by:

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

Returns:

the type specific comparator

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

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>