speiger.src.collections.ints.sets

Interface IntOrderedSet

All Superinterfaces:

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

All Known Implementing Classes:

ImmutableIntOpenHashSet, IntArraySet, IntLinkedOpenCustomHashSet, IntLinkedOpenHashSet

public interface IntOrderedSet
extends IntSet

A Special Set Interface giving Access to some really usefull functions The Idea behind this interface is to allow access to functions that give control to the Order of elements. Since Linked implementations as examples can be reordered outside of the Insertion Order. This interface provides basic access to such functions while also providing some Sorted/NaivgableSet implementations that still fit into here.

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.
IntOrderedSet	copy() A Function that does a shallow clone of the Collection itself.
int	firstInt() A method to get the first element in the set
IntBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
IntBidirectionalIterator	iterator(int fromElement) A type Specific Iterator starting from a given key
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 IntOrderedSet	synchronize() Creates a Wrapped OrderedSet that is Synchronized
default IntOrderedSet	synchronize(java.lang.Object mutex) Creates a Wrapped OrderedSet that is Synchronized
default IntOrderedSet	unmodifiable() Creates a Wrapped OrderedSet that is unmodifiable

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

add, contains, remInt, remove, remove

Methods inherited from interface java.util.Set

addAll, clear, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, size, toArray, toArray

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 java.util.Collection

parallelStream, stream

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

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)

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)

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

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

copy

IntOrderedSet 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

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>

Returns:

type specific splititerator

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

synchronize

default IntOrderedSet synchronize()

Creates a Wrapped OrderedSet that is Synchronized

Specified by:

synchronize in interface IntCollection

Specified by:

synchronize in interface IntSet

Returns:

a new OrderedSet that is synchronized

See Also:

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

synchronize

default IntOrderedSet synchronize(java.lang.Object mutex)

Creates a Wrapped OrderedSet 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 OrderedSet Wrapper that is synchronized

See Also:

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

unmodifiable

default IntOrderedSet unmodifiable()

Creates a Wrapped OrderedSet that is unmodifiable

Specified by:

unmodifiable in interface IntCollection

Specified by:

unmodifiable in interface IntSet

Returns:

a new OrderedSet Wrapper that is unmodifiable

See Also:

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