speiger.src.collections.longs.sets

Interface LongOrderedSet

All Superinterfaces:

java.util.Collection<java.lang.Long>, java.lang.Iterable<java.lang.Long>, LongCollection, LongIterable, LongSet, java.util.Set<java.lang.Long>

All Known Implementing Classes:

ImmutableLongOpenHashSet, LongArraySet, LongLinkedOpenCustomHashSet, LongLinkedOpenHashSet

public interface LongOrderedSet
extends LongSet

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(long o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(long o) A customized add method that allows you to insert into the last index.
LongOrderedSet	copy() A Function that does a shallow clone of the Collection itself.
long	firstLong() A method to get the first element in the set
LongBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
LongBidirectionalIterator	iterator(long fromElement) A type Specific Iterator starting from a given key
long	lastLong() A method to get the last element in the set
boolean	moveToFirst(long o) A specific move method to move a given key to the first index.
boolean	moveToLast(long o) A specific move method to move a given key to the last index.
long	pollFirstLong() A method to get and remove the first element in the set
long	pollLastLong() A method to get and remove the last element in the set
default LongSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
default LongOrderedSet	synchronize() Creates a Wrapped OrderedSet that is Synchronized
default LongOrderedSet	synchronize(java.lang.Object mutex) Creates a Wrapped OrderedSet that is Synchronized
default LongOrderedSet	unmodifiable() Creates a Wrapped OrderedSet that is unmodifiable

Methods inherited from interface speiger.src.collections.longs.sets.LongSet

add, contains, remLong, 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.longs.collections.LongCollection

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

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface speiger.src.collections.longs.collections.LongIterable

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

LongOrderedSet copy()

Description copied from interface: LongCollection

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 LongCollection

Specified by:

copy in interface LongSet

Returns:

a Shallow Copy of the collection

iterator

LongBidirectionalIterator iterator()

Description copied from interface: LongCollection

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface LongCollection

Specified by:

iterator in interface LongIterable

Specified by:

iterator in interface LongSet

Specified by:

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

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

LongBidirectionalIterator iterator(long 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 LongSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

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

Specified by:

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

Specified by:

spliterator in interface LongCollection

Specified by:

spliterator in interface LongIterable

Specified by:

spliterator in interface LongSet

Specified by:

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

Returns:

type specific splititerator

firstLong

long firstLong()

A method to get the first element in the set

Returns:

first element in the set

pollFirstLong

long pollFirstLong()

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

Returns:

first element in the set

lastLong

long lastLong()

A method to get the last element in the set

Returns:

last element in the set

pollLastLong

long pollLastLong()

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

Returns:

last element in the set

synchronize

default LongOrderedSet synchronize()

Creates a Wrapped OrderedSet that is Synchronized

Specified by:

synchronize in interface LongCollection

Specified by:

synchronize in interface LongSet

Returns:

a new OrderedSet that is synchronized

See Also:

LongSets.synchronize(speiger.src.collections.longs.sets.LongSet)

synchronize

default LongOrderedSet synchronize(java.lang.Object mutex)

Creates a Wrapped OrderedSet that is Synchronized

Specified by:

synchronize in interface LongCollection

Specified by:

synchronize in interface LongSet

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new OrderedSet Wrapper that is synchronized

See Also:

LongSets.synchronize(speiger.src.collections.longs.sets.LongSet)

unmodifiable

default LongOrderedSet unmodifiable()

Creates a Wrapped OrderedSet that is unmodifiable

Specified by:

unmodifiable in interface LongCollection

Specified by:

unmodifiable in interface LongSet

Returns:

a new OrderedSet Wrapper that is unmodifiable

See Also:

LongSets.unmodifiable(speiger.src.collections.longs.sets.LongSet)