speiger.src.collections.shorts.sets

Class ShortArraySet

java.lang.Object

java.util.AbstractCollection<java.lang.Short>

speiger.src.collections.shorts.collections.AbstractShortCollection

speiger.src.collections.shorts.sets.AbstractShortSet

speiger.src.collections.shorts.sets.ShortArraySet

All Implemented Interfaces:

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

public class ShortArraySet
extends AbstractShortSet
implements ShortSortedSet

A Type Specific ArraySet implementation. That is based around the idea of List.indexOf(Object) for no duplication. Unless a array constructor is used the ArraySet does not allow for duplication. This implementation does not shrink the backing array

Constructor Summary

Constructors

Constructor and Description
ShortArraySet() Default Constructor
ShortArraySet(java.util.Collection<? extends java.lang.Short> c) Deprecated.
ShortArraySet(int capacity) Minimum Capacity Constructor
ShortArraySet(java.util.Set<? extends java.lang.Short> s) Deprecated.
ShortArraySet(short[] array) Constructur using initial Array
ShortArraySet(short[] array, int length) Constructur using initial Array
ShortArraySet(ShortCollection c) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ShortArraySet(ShortSet s) A Helper constructor that fast copies the element out of a set into the ArraySet.

Method Summary

Modifier and Type	Method and Description
boolean	add(short o) A Type-Specific add function to reduce (un)boxing
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.
void	clear()
ShortComparator	comparator() A Type Specific Comparator method
boolean	contains(short e) A Type-Specific implementation of contains.
short	firstShort() A method to get the first element in the set
void	forEach(ShortConsumer action) A Type Specific foreach function that reduces (un)boxing
ShortSortedSet	headSet(short toElement) A Type Specific HeadSet method to reduce boxing/unboxing
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
boolean	remIf(java.util.function.IntPredicate filter) A Type-Specific removeIf function to reduce (un)boxing.
boolean	remove(short o) A Type Specific remove function to reduce boxing/unboxing
boolean	removeAll(java.util.Collection<?> c) Deprecated.
boolean	removeAll(ShortCollection c) A Type-Specific implementation of removeAll.
boolean	retainAll(java.util.Collection<?> c) Deprecated.
boolean	retainAll(ShortCollection c) A Type-Specific implementation of retainAll.
int	size()
ShortSortedSet	subSet(short fromElement, short toElement) A Type Specific SubSet method to reduce boxing/unboxing
ShortSortedSet	tailSet(short fromElement) A Type Specific TailSet method to reduce boxing/unboxing
java.lang.Object[]	toArray() Deprecated.
<E> E[]	toArray(E[] a) Deprecated.
short[]	toShortArray(short[] a) A Type-Specific implementation of toArray.

Methods inherited from class speiger.src.collections.shorts.sets.AbstractShortSet

equals, hashCode

Methods inherited from class speiger.src.collections.shorts.collections.AbstractShortCollection

add, addAll, addAll, contains, containsAll, containsAny, containsAny, remove, remShort, toShortArray

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

first, headSet, last, spliterator, subSet, tailSet

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

add, contains, remove, remShort

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

addAll, containsAll, containsAny, containsAny, parallelPrimitiveStream, primitiveStream, removeIf, toShortArray

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

forEach

Methods inherited from interface java.util.Set

addAll, containsAll, equals, hashCode, isEmpty

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

ShortArraySet

public ShortArraySet()

Default Constructor

ShortArraySet

public ShortArraySet(int capacity)

Minimum Capacity Constructor

Parameters:

capacity - the minimum capacity of the internal array

Throws:

java.lang.NegativeArraySizeException - if the capacity is negative

ShortArraySet

public ShortArraySet(short[] array)

Constructur using initial Array

Parameters:

array - the array that should be used for set.

ShortArraySet

public ShortArraySet(short[] array,
                     int length)

Constructur using initial Array

Parameters:

array - the array that should be used for set.

length - the amount of elements present within the array

Throws:

java.lang.NegativeArraySizeException - if the length is negative

ShortArraySet

@Deprecated
public ShortArraySet(java.util.Collection<? extends java.lang.Short> c)

Deprecated.

A Helper constructor that allows to create a Set with exactly the same values as the provided collection.

Parameters:

c - the elements that should be added to the set.

Note:

this slowly checks every element to remove duplicates

ShortArraySet

public ShortArraySet(ShortCollection c)

A Helper constructor that allows to create a Set with exactly the same values as the provided collection.

Parameters:

c - the elements that should be added to the set.

Note:

this slowly checks every element to remove duplicates

ShortArraySet

@Deprecated
public ShortArraySet(java.util.Set<? extends java.lang.Short> s)

Deprecated.

A Helper constructor that fast copies the element out of a set into the ArraySet. Since it is assumed that there is no duplication in the first place

Parameters:

s - the set the element should be taken from

ShortArraySet

public ShortArraySet(ShortSet s)

A Helper constructor that fast copies the element out of a set into the ArraySet. Since it is assumed that there is no duplication in the first place

Parameters:

s - the set the element should be taken from

Method Detail

add

public boolean add(short o)

Description copied from interface: ShortCollection

A Type-Specific add function to reduce (un)boxing

Specified by:

add in interface ShortCollection

Parameters:

o - the element that should be added

Returns:

true if the element was added to the collection

addAndMoveToFirst

public boolean addAndMoveToFirst(short o)

Description copied from interface: ShortSortedSet

A customized add method that allows you to insert into the first index.

Specified by:

addAndMoveToFirst in interface ShortSortedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

addAndMoveToLast

public boolean addAndMoveToLast(short o)

Description copied from interface: ShortSortedSet

A customized add method that allows you to insert into the last index.

Specified by:

addAndMoveToLast in interface ShortSortedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

moveToFirst

public boolean moveToFirst(short o)

Description copied from interface: ShortSortedSet

A specific move method to move a given key to the first index.

Specified by:

moveToFirst in interface ShortSortedSet

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(short o)

Description copied from interface: ShortSortedSet

A specific move method to move a given key to the last index.

Specified by:

moveToLast in interface ShortSortedSet

Parameters:

o - that should be moved to the first last

Returns:

true if the value was moved.

contains

public boolean contains(short e)

Description copied from class: AbstractShortCollection

A Type-Specific implementation of contains. This implementation iterates over the elements and returns true if the value match.

Specified by:

contains in interface ShortCollection

Overrides:

contains in class AbstractShortCollection

Parameters:

e - the element that should be searched for.

Returns:

true if the value was found.

firstShort

public short firstShort()

Description copied from interface: ShortSortedSet

A method to get the first element in the set

Specified by:

firstShort in interface ShortSortedSet

Returns:

first element in the set

lastShort

public short lastShort()

Description copied from interface: ShortSortedSet

A method to get the last element in the set

Specified by:

lastShort in interface ShortSortedSet

Returns:

last element in the set

removeAll

public boolean removeAll(ShortCollection c)

Description copied from class: AbstractShortCollection

A Type-Specific implementation of removeAll. This Implementation iterates over all elements and removes them as they were found in the other collection.

Specified by:

removeAll in interface ShortCollection

Overrides:

removeAll in class AbstractShortCollection

Parameters:

c - the elements that should be deleted

Returns:

true if the collection was modified.

See Also:

Collection.removeAll(Collection)

retainAll

public boolean retainAll(ShortCollection c)

Description copied from class: AbstractShortCollection

A Type-Specific implementation of retainAll. This Implementation iterates over all elements and removes them as they were not found in the other collection.

Specified by:

retainAll in interface ShortCollection

Overrides:

retainAll in class AbstractShortCollection

Parameters:

c - the elements that should be kept

Returns:

true if the collection was modified.

See Also:

Collection.retainAll(Collection)

removeAll

@Deprecated
public boolean removeAll(java.util.Collection<?> c)

Deprecated.

Specified by:

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

Specified by:

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

Overrides:

removeAll in class java.util.AbstractCollection<java.lang.Short>

retainAll

@Deprecated
public boolean retainAll(java.util.Collection<?> c)

Deprecated.

Specified by:

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

Specified by:

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

Overrides:

retainAll in class java.util.AbstractCollection<java.lang.Short>

remove

public boolean remove(short o)

Description copied from interface: ShortSet

A Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface ShortSet

Parameters:

o - the element that should be removed

Returns:

true if the element was removed

pollFirstShort

public short pollFirstShort()

Description copied from interface: ShortSortedSet

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

Specified by:

pollFirstShort in interface ShortSortedSet

Returns:

first element in the set

pollLastShort

public short pollLastShort()

Description copied from interface: ShortSortedSet

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

Specified by:

pollLastShort in interface ShortSortedSet

Returns:

last element in the set

remIf

public boolean remIf(java.util.function.IntPredicate filter)

Description copied from interface: ShortCollection

A Type-Specific removeIf function to reduce (un)boxing.

Removes elements that were selected by the filter

Specified by:

remIf in interface ShortCollection

Parameters:

filter - Filters the elements that should be removed

Returns:

true if the collection was modified

See Also:

Collection.removeIf(Predicate)

forEach

public void forEach(ShortConsumer action)

Description copied from interface: ShortIterable

A Type Specific foreach function that reduces (un)boxing

Specified by:

forEach in interface ShortIterable

Parameters:

action - The action to be performed for each element

See Also:

Iterable.forEach(Consumer)

iterator

public ShortBidirectionalIterator iterator()

Description copied from interface: ShortCollection

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface ShortSortedSet

Specified by:

iterator in class AbstractShortSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

public ShortBidirectionalIterator iterator(short fromElement)

Description copied from interface: ShortSortedSet

A type Specific Iterator starting from a given key

Specified by:

iterator in interface ShortSortedSet

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

subSet

public ShortSortedSet subSet(short fromElement,
                             short toElement)

Description copied from interface: ShortSortedSet

A Type Specific SubSet method to reduce boxing/unboxing

Specified by:

subSet in interface ShortSortedSet

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

headSet

public ShortSortedSet headSet(short toElement)

Description copied from interface: ShortSortedSet

A Type Specific HeadSet method to reduce boxing/unboxing

Specified by:

headSet in interface ShortSortedSet

Parameters:

toElement - where the HeadSet should end

Returns:

a HeadSet that is within the range of the desired range

tailSet

public ShortSortedSet tailSet(short fromElement)

Description copied from interface: ShortSortedSet

A Type Specific TailSet method to reduce boxing/unboxing

Specified by:

tailSet in interface ShortSortedSet

Parameters:

fromElement - where the TailSet should start

Returns:

a TailSet that is within the range of the desired range

comparator

public ShortComparator comparator()

Description copied from interface: ShortSortedSet

A Type Specific Comparator method

Specified by:

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

Specified by:

comparator in interface ShortSortedSet

Returns:

the type specific comparator

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

clear in class java.util.AbstractCollection<java.lang.Short>

size

public int size()

Specified by:

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

Specified by:

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

Specified by:

size in class java.util.AbstractCollection<java.lang.Short>

toShortArray

public short[] toShortArray(short[] a)

Description copied from class: AbstractShortCollection

A Type-Specific implementation of toArray. This implementation iterates over all elements and unwraps them into primitive type.

Specified by:

toShortArray in interface ShortCollection

Overrides:

toShortArray in class AbstractShortCollection

Parameters:

a - array that the elements should be injected to. If null or to small a new array with the right size is created

Returns:

an array containing all of the elements in this collection

See Also:

Collection.toArray(Object[])

toArray

@Deprecated
public java.lang.Object[] toArray()

Deprecated.

Specified by:

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

Specified by:

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

Overrides:

toArray in class java.util.AbstractCollection<java.lang.Short>

toArray

@Deprecated
public <E> E[] toArray(E[] a)

Deprecated.

Specified by:

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

Specified by:

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

Overrides:

toArray in class java.util.AbstractCollection<java.lang.Short>