speiger.src.collections.bytes.sets

Class ByteArraySet

java.lang.Object

java.util.AbstractCollection<java.lang.Byte>

speiger.src.collections.bytes.collections.AbstractByteCollection

speiger.src.collections.bytes.sets.AbstractByteSet

speiger.src.collections.bytes.sets.ByteArraySet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Byte>, java.util.Collection<java.lang.Byte>, java.util.Set<java.lang.Byte>, java.util.SortedSet<java.lang.Byte>, ByteCollection, ByteIterable, ByteSet, ByteSortedSet

public class ByteArraySet
extends AbstractByteSet
implements ByteSortedSet

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
ByteArraySet() Default Constructor
ByteArraySet(byte[] array) Constructur using initial Array
ByteArraySet(byte[] array, int length) Constructur using initial Array
ByteArraySet(ByteCollection c) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ByteArraySet(ByteSet s) A Helper constructor that fast copies the element out of a set into the ArraySet.
ByteArraySet(java.util.Collection<? extends java.lang.Byte> c) Deprecated.
ByteArraySet(int capacity) Minimum Capacity Constructor
ByteArraySet(java.util.Set<? extends java.lang.Byte> s) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	add(byte o) A Type-Specific add function to reduce (un)boxing
boolean	addAndMoveToFirst(byte o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(byte o) A customized add method that allows you to insert into the last index.
void	clear()
ByteComparator	comparator() A Type Specific Comparator method
boolean	contains(byte e) A Type-Specific implementation of contains.
byte	firstByte() A method to get the first element in the set
void	forEach(ByteConsumer action) A Type Specific foreach function that reduces (un)boxing
ByteSortedSet	headSet(byte toElement) A Type Specific HeadSet method to reduce boxing/unboxing
ByteBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
ByteBidirectionalIterator	iterator(byte fromElement) A type Specific Iterator starting from a given key
byte	lastByte() A method to get the last element in the set
boolean	moveToFirst(byte o) A specific move method to move a given key to the first index.
boolean	moveToLast(byte o) A specific move method to move a given key to the last index.
byte	pollFirstByte() A method to get and remove the first element in the set
byte	pollLastByte() 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(byte o) A Type Specific remove function to reduce boxing/unboxing
boolean	removeAll(ByteCollection c) A Type-Specific implementation of removeAll.
boolean	removeAll(java.util.Collection<?> c) Deprecated.
boolean	retainAll(ByteCollection c) A Type-Specific implementation of retainAll.
boolean	retainAll(java.util.Collection<?> c) Deprecated.
int	size()
ByteSortedSet	subSet(byte fromElement, byte toElement) A Type Specific SubSet method to reduce boxing/unboxing
ByteSortedSet	tailSet(byte fromElement) A Type Specific TailSet method to reduce boxing/unboxing
java.lang.Object[]	toArray() Deprecated.
<E> E[]	toArray(E[] a) Deprecated.
byte[]	toByteArray(byte[] a) A Type-Specific implementation of toArray.

Methods inherited from class speiger.src.collections.bytes.sets.AbstractByteSet

equals, hashCode

Methods inherited from class speiger.src.collections.bytes.collections.AbstractByteCollection

add, addAll, addAll, contains, containsAll, containsAny, containsAny, remByte, remove, toByteArray

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.bytes.sets.ByteSortedSet

first, headSet, last, spliterator, subSet, tailSet

Methods inherited from interface speiger.src.collections.bytes.sets.ByteSet

add, contains, remByte, remove

Methods inherited from interface speiger.src.collections.bytes.collections.ByteCollection

addAll, containsAll, containsAny, containsAny, parallelPrimitiveStream, primitiveStream, removeIf, toByteArray

Methods inherited from interface speiger.src.collections.bytes.collections.ByteIterable

forEach

Methods inherited from interface java.util.Set

addAll, containsAll, equals, hashCode, isEmpty

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

ByteArraySet

public ByteArraySet()

Default Constructor

ByteArraySet

public ByteArraySet(int capacity)

Minimum Capacity Constructor

Parameters:

capacity - the minimum capacity of the internal array

Throws:

java.lang.NegativeArraySizeException - if the capacity is negative

ByteArraySet

public ByteArraySet(byte[] array)

Constructur using initial Array

Parameters:

array - the array that should be used for set.

ByteArraySet

public ByteArraySet(byte[] 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

ByteArraySet

@Deprecated
public ByteArraySet(java.util.Collection<? extends java.lang.Byte> 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

ByteArraySet

public ByteArraySet(ByteCollection 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

ByteArraySet

@Deprecated
public ByteArraySet(java.util.Set<? extends java.lang.Byte> 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

ByteArraySet

public ByteArraySet(ByteSet 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(byte o)

Description copied from interface: ByteCollection

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

Specified by:

add in interface ByteCollection

Parameters:

o - the element that should be added

Returns:

true if the element was added to the collection

addAndMoveToFirst

public boolean addAndMoveToFirst(byte o)

Description copied from interface: ByteSortedSet

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

Specified by:

addAndMoveToFirst in interface ByteSortedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

addAndMoveToLast

public boolean addAndMoveToLast(byte o)

Description copied from interface: ByteSortedSet

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

Specified by:

addAndMoveToLast in interface ByteSortedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

moveToFirst

public boolean moveToFirst(byte o)

Description copied from interface: ByteSortedSet

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

Specified by:

moveToFirst in interface ByteSortedSet

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(byte o)

Description copied from interface: ByteSortedSet

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

Specified by:

moveToLast in interface ByteSortedSet

Parameters:

o - that should be moved to the first last

Returns:

true if the value was moved.

contains

public boolean contains(byte e)

Description copied from class: AbstractByteCollection

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

Specified by:

contains in interface ByteCollection

Overrides:

contains in class AbstractByteCollection

Parameters:

e - the element that should be searched for.

Returns:

true if the value was found.

firstByte

public byte firstByte()

Description copied from interface: ByteSortedSet

A method to get the first element in the set

Specified by:

firstByte in interface ByteSortedSet

Returns:

first element in the set

lastByte

public byte lastByte()

Description copied from interface: ByteSortedSet

A method to get the last element in the set

Specified by:

lastByte in interface ByteSortedSet

Returns:

last element in the set

removeAll

public boolean removeAll(ByteCollection c)

Description copied from class: AbstractByteCollection

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 ByteCollection

Overrides:

removeAll in class AbstractByteCollection

Parameters:

c - the elements that should be deleted

Returns:

true if the collection was modified.

See Also:

Collection.removeAll(Collection)

retainAll

public boolean retainAll(ByteCollection c)

Description copied from class: AbstractByteCollection

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 ByteCollection

Overrides:

retainAll in class AbstractByteCollection

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.Byte>

Specified by:

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

Overrides:

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

retainAll

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

Deprecated.

Specified by:

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

Specified by:

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

Overrides:

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

remove

public boolean remove(byte o)

Description copied from interface: ByteSet

A Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface ByteSet

Parameters:

o - the element that should be removed

Returns:

true if the element was removed

pollFirstByte

public byte pollFirstByte()

Description copied from interface: ByteSortedSet

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

Specified by:

pollFirstByte in interface ByteSortedSet

Returns:

first element in the set

pollLastByte

public byte pollLastByte()

Description copied from interface: ByteSortedSet

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

Specified by:

pollLastByte in interface ByteSortedSet

Returns:

last element in the set

remIf

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

Description copied from interface: ByteCollection

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

Removes elements that were selected by the filter

Specified by:

remIf in interface ByteCollection

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(ByteConsumer action)

Description copied from interface: ByteIterable

A Type Specific foreach function that reduces (un)boxing

Specified by:

forEach in interface ByteIterable

Parameters:

action - The action to be performed for each element

See Also:

Iterable.forEach(Consumer)

iterator

public ByteBidirectionalIterator iterator()

Description copied from interface: ByteCollection

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface ByteCollection

Specified by:

iterator in interface ByteIterable

Specified by:

iterator in interface ByteSet

Specified by:

iterator in interface ByteSortedSet

Specified by:

iterator in class AbstractByteSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

public ByteBidirectionalIterator iterator(byte fromElement)

Description copied from interface: ByteSortedSet

A type Specific Iterator starting from a given key

Specified by:

iterator in interface ByteSortedSet

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

subSet

public ByteSortedSet subSet(byte fromElement,
                            byte toElement)

Description copied from interface: ByteSortedSet

A Type Specific SubSet method to reduce boxing/unboxing

Specified by:

subSet in interface ByteSortedSet

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 ByteSortedSet headSet(byte toElement)

Description copied from interface: ByteSortedSet

A Type Specific HeadSet method to reduce boxing/unboxing

Specified by:

headSet in interface ByteSortedSet

Parameters:

toElement - where the HeadSet should end

Returns:

a HeadSet that is within the range of the desired range

tailSet

public ByteSortedSet tailSet(byte fromElement)

Description copied from interface: ByteSortedSet

A Type Specific TailSet method to reduce boxing/unboxing

Specified by:

tailSet in interface ByteSortedSet

Parameters:

fromElement - where the TailSet should start

Returns:

a TailSet that is within the range of the desired range

comparator

public ByteComparator comparator()

Description copied from interface: ByteSortedSet

A Type Specific Comparator method

Specified by:

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

Specified by:

comparator in interface ByteSortedSet

Returns:

the type specific comparator

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

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

size

public int size()

Specified by:

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

Specified by:

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

Specified by:

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

toByteArray

public byte[] toByteArray(byte[] a)

Description copied from class: AbstractByteCollection

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

Specified by:

toByteArray in interface ByteCollection

Overrides:

toByteArray in class AbstractByteCollection

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.Byte>

Specified by:

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

Overrides:

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

toArray

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

Deprecated.

Specified by:

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

Specified by:

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

Overrides:

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