speiger.src.collections.bytes.sets

Class ByteLinkedOpenCustomHashSet

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

speiger.src.collections.bytes.sets.ByteLinkedOpenCustomHashSet

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, ITrimmable

public class ByteLinkedOpenCustomHashSet
extends ByteOpenCustomHashSet
implements ByteSortedSet

A Type Specific LinkedHashSet that allows for custom HashControl. That uses arrays to create links between nodes. For cases where Objects/primitive do not allow hashcoding this can be really useful and provide a lot of control. This implementation of SortedSet does not support SubSet of any kind. It implements the interface due to sortability and first/last access

Constructor Summary

Constructors

Constructor and Description
ByteLinkedOpenCustomHashSet(byte[] array, ByteStrategy strategy) Helper constructor that allow to create a set from unboxed values
ByteLinkedOpenCustomHashSet(byte[] array, float loadFactor, ByteStrategy strategy) Helper constructor that allow to create a set from unboxed values
ByteLinkedOpenCustomHashSet(byte[] array, int offset, int length, ByteStrategy strategy) Helper constructor that allow to create a set from unboxed values
ByteLinkedOpenCustomHashSet(byte[] array, int offset, int length, float loadFactor, ByteStrategy strategy) Helper constructor that allow to create a set from unboxed values
ByteLinkedOpenCustomHashSet(ByteCollection collection, ByteStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ByteLinkedOpenCustomHashSet(ByteCollection collection, float loadFactor, ByteStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ByteLinkedOpenCustomHashSet(ByteIterator iterator, ByteStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
ByteLinkedOpenCustomHashSet(ByteIterator iterator, float loadFactor, ByteStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
ByteLinkedOpenCustomHashSet(ByteStrategy strategy) Default Contstructor
ByteLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Byte> collection, ByteStrategy strategy) Deprecated.
ByteLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Byte> collection, float loadFactor, ByteStrategy strategy) Deprecated.
ByteLinkedOpenCustomHashSet(int minCapacity, ByteStrategy strategy) Constructor that defines the minimum capacity
ByteLinkedOpenCustomHashSet(int minCapacity, float loadFactor, ByteStrategy strategy) Constructor that defines the minimum capacity and load factor
ByteLinkedOpenCustomHashSet(java.util.Iterator<java.lang.Byte> iterator, ByteStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
ByteLinkedOpenCustomHashSet(java.util.Iterator<java.lang.Byte> iterator, float loadFactor, ByteStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size

Method Summary

Modifier and Type	Method and Description
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()
void	clearAndTrim(int size) Trims the collection down to the requested size and clears all elements while doing so
ByteComparator	comparator() A Type Specific Comparator method
byte	firstByte() A method to get the first element in the set
ByteSortedSet	headSet(byte toElement) A Type Specific HeadSet method to reduce boxing/unboxing
ByteListIterator	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
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

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

add, addAll, addAll, contains, getStrategy, remove, size, trim

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

equals, hashCode

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

add, contains, containsAll, containsAny, containsAny, remByte, remove, removeAll, retainAll, toByteArray, toByteArray

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, toArray, toArray, 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, remove

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

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

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

forEach, forEach

Methods inherited from interface java.util.Set

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

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface speiger.src.collections.utils.ITrimmable

clearAndTrim, trim

Constructor Detail

ByteLinkedOpenCustomHashSet

public ByteLinkedOpenCustomHashSet(ByteStrategy strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

ByteLinkedOpenCustomHashSet

public ByteLinkedOpenCustomHashSet(int minCapacity,
                                   ByteStrategy strategy)

Constructor that defines the minimum capacity

Parameters:

minCapacity - the minimum capacity the HashSet is allowed to be.

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

java.lang.IllegalStateException - if the minimum capacity is negative

ByteLinkedOpenCustomHashSet

public ByteLinkedOpenCustomHashSet(int minCapacity,
                                   float loadFactor,
                                   ByteStrategy strategy)

Constructor that defines the minimum capacity and load factor

Parameters:

minCapacity - the minimum capacity the HashSet is allowed to be.

loadFactor - the percentage of how full the backing array can be before they resize

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

java.lang.IllegalStateException - if the minimum capacity is negative

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

ByteLinkedOpenCustomHashSet

public ByteLinkedOpenCustomHashSet(byte[] array,
                                   ByteStrategy strategy)

Helper constructor that allow to create a set from unboxed values

Parameters:

array - the elements that should be put into the set

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

ByteLinkedOpenCustomHashSet

public ByteLinkedOpenCustomHashSet(byte[] array,
                                   float loadFactor,
                                   ByteStrategy strategy)

Helper constructor that allow to create a set from unboxed values

Parameters:

array - the elements that should be put into the set

loadFactor - the percentage of how full the backing array can be before they resize

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

ByteLinkedOpenCustomHashSet

public ByteLinkedOpenCustomHashSet(byte[] array,
                                   int offset,
                                   int length,
                                   ByteStrategy strategy)

Helper constructor that allow to create a set from unboxed values

Parameters:

array - the elements that should be put into the set

offset - the starting index within the array that should be used

length - the amount of elements used from the array

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

java.lang.IllegalStateException - if offset and length causes to step outside of the arrays range

ByteLinkedOpenCustomHashSet

public ByteLinkedOpenCustomHashSet(byte[] array,
                                   int offset,
                                   int length,
                                   float loadFactor,
                                   ByteStrategy strategy)

Helper constructor that allow to create a set from unboxed values

Parameters:

array - the elements that should be put into the set

offset - the starting index within the array that should be used

length - the amount of elements used from the array

loadFactor - the percentage of how full the backing array can be before they resize

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

java.lang.IllegalStateException - if offset and length causes to step outside of the arrays range

ByteLinkedOpenCustomHashSet

@Deprecated
public ByteLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Byte> collection,
                                                ByteStrategy strategy)

Deprecated.

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

Parameters:

collection - the set the elements should be added to the Set

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

ByteLinkedOpenCustomHashSet

@Deprecated
public ByteLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Byte> collection,
                                                float loadFactor,
                                                ByteStrategy strategy)

Deprecated.

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

Parameters:

collection - the set the elements should be added to the Set

loadFactor - the percentage of how full the backing array can be before they resize

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

ByteLinkedOpenCustomHashSet

public ByteLinkedOpenCustomHashSet(ByteCollection collection,
                                   ByteStrategy strategy)

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

Parameters:

collection - the set the elements should be added to the Set

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

ByteLinkedOpenCustomHashSet

public ByteLinkedOpenCustomHashSet(ByteCollection collection,
                                   float loadFactor,
                                   ByteStrategy strategy)

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

Parameters:

collection - the set the elements should be added to the Set

loadFactor - the percentage of how full the backing array can be before they resize

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

ByteLinkedOpenCustomHashSet

public ByteLinkedOpenCustomHashSet(java.util.Iterator<java.lang.Byte> iterator,
                                   ByteStrategy strategy)

A Helper constructor that allows to create a set from a iterator of an unknown size

Parameters:

iterator - the elements that should be added to the set

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

ByteLinkedOpenCustomHashSet

public ByteLinkedOpenCustomHashSet(java.util.Iterator<java.lang.Byte> iterator,
                                   float loadFactor,
                                   ByteStrategy strategy)

A Helper constructor that allows to create a set from a iterator of an unknown size

Parameters:

iterator - the elements that should be added to the set

loadFactor - the percentage of how full the backing array can be before they resize

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

ByteLinkedOpenCustomHashSet

public ByteLinkedOpenCustomHashSet(ByteIterator iterator,
                                   ByteStrategy strategy)

A Helper constructor that allows to create a set from a iterator of an unknown size

Parameters:

iterator - the elements that should be added to the set

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

ByteLinkedOpenCustomHashSet

public ByteLinkedOpenCustomHashSet(ByteIterator iterator,
                                   float loadFactor,
                                   ByteStrategy strategy)

A Helper constructor that allows to create a set from a iterator of an unknown size

Parameters:

iterator - the elements that should be added to the set

loadFactor - the percentage of how full the backing array can be before they resize

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Method Detail

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.

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

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

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

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

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 ByteOpenCustomHashSet

clearAndTrim

public void clearAndTrim(int size)

Description copied from interface: ITrimmable

Trims the collection down to the requested size and clears all elements while doing so

Specified by:

clearAndTrim in interface ITrimmable

Overrides:

clearAndTrim in class ByteOpenCustomHashSet

Parameters:

size - the amount of elements that should be allowed

iterator

public ByteListIterator 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

Overrides:

iterator in class ByteOpenCustomHashSet

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

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

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