speiger.src.collections.shorts.sets

Interface ShortOrderedSet

All Superinterfaces:

java.util.Collection<java.lang.Short>, java.lang.Iterable<java.lang.Short>, java.util.Set<java.lang.Short>, ShortCollection, ShortIterable, ShortSet

All Known Implementing Classes:

ImmutableShortOpenHashSet, ShortArraySet, ShortLinkedOpenCustomHashSet, ShortLinkedOpenHashSet

public interface ShortOrderedSet
extends ShortSet

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

Methods inherited from interface speiger.src.collections.shorts.sets.ShortSet

add, contains, remove, remove, remShort

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.shorts.collections.ShortCollection

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

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface speiger.src.collections.shorts.collections.ShortIterable

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

ShortOrderedSet copy()

Description copied from interface: ShortCollection

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 ShortCollection

Specified by:

copy in interface ShortSet

Returns:

a Shallow Copy of the collection

iterator

ShortBidirectionalIterator iterator()

Description copied from interface: ShortCollection

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface ShortCollection

Specified by:

iterator in interface ShortIterable

Specified by:

iterator in interface ShortSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

ShortBidirectionalIterator iterator(short 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 ShortSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

spliterator in interface ShortCollection

Specified by:

spliterator in interface ShortIterable

Specified by:

spliterator in interface ShortSet

Returns:

type specific splititerator

firstShort

short firstShort()

A method to get the first element in the set

Returns:

first element in the set

pollFirstShort

short pollFirstShort()

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

Returns:

first element in the set

lastShort

short lastShort()

A method to get the last element in the set

Returns:

last element in the set

pollLastShort

short pollLastShort()

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

Returns:

last element in the set

synchronize

default ShortOrderedSet synchronize()

Creates a Wrapped OrderedSet that is Synchronized

Specified by:

synchronize in interface ShortCollection

Specified by:

synchronize in interface ShortSet

Returns:

a new OrderedSet that is synchronized

See Also:

ShortSets.synchronize(speiger.src.collections.shorts.sets.ShortSet)

synchronize

default ShortOrderedSet synchronize(java.lang.Object mutex)

Creates a Wrapped OrderedSet that is Synchronized

Specified by:

synchronize in interface ShortCollection

Specified by:

synchronize in interface ShortSet

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new OrderedSet Wrapper that is synchronized

See Also:

ShortSets.synchronize(speiger.src.collections.shorts.sets.ShortSet)

unmodifiable

default ShortOrderedSet unmodifiable()

Creates a Wrapped OrderedSet that is unmodifiable

Specified by:

unmodifiable in interface ShortCollection

Specified by:

unmodifiable in interface ShortSet

Returns:

a new OrderedSet Wrapper that is unmodifiable

See Also:

ShortSets.unmodifiable(speiger.src.collections.shorts.sets.ShortSet)