speiger.src.collections.bytes.sets

Class ByteOpenCustomHashSet

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ByteLinkedOpenCustomHashSet

public class ByteOpenCustomHashSet
extends AbstractByteSet
implements ITrimmable

A Type Specific HashSet that allows for custom HashControl. For cases where Objects/primitive do not allow hashcoding this can be really useful and provide a lot of control.

Constructor Summary

Constructors

Constructor and Description
ByteOpenCustomHashSet(byte[] array, ByteStrategy strategy) Helper constructor that allow to create a set from unboxed values
ByteOpenCustomHashSet(byte[] array, float loadFactor, ByteStrategy strategy) Helper constructor that allow to create a set from unboxed values
ByteOpenCustomHashSet(byte[] array, int offset, int length, ByteStrategy strategy) Helper constructor that allow to create a set from unboxed values
ByteOpenCustomHashSet(byte[] array, int offset, int length, float loadFactor, ByteStrategy strategy) Helper constructor that allow to create a set from unboxed values
ByteOpenCustomHashSet(ByteCollection collection, ByteStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ByteOpenCustomHashSet(ByteCollection collection, float loadFactor, ByteStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ByteOpenCustomHashSet(ByteIterator iterator, ByteStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
ByteOpenCustomHashSet(ByteIterator iterator, float loadFactor, ByteStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
ByteOpenCustomHashSet(ByteStrategy strategy) Default Contstructor
ByteOpenCustomHashSet(java.util.Collection<? extends java.lang.Byte> collection, ByteStrategy strategy) Deprecated.
ByteOpenCustomHashSet(java.util.Collection<? extends java.lang.Byte> collection, float loadFactor, ByteStrategy strategy) Deprecated.
ByteOpenCustomHashSet(int minCapacity, ByteStrategy strategy) Constructor that defines the minimum capacity
ByteOpenCustomHashSet(int minCapacity, float loadFactor, ByteStrategy strategy) Constructor that defines the minimum capacity and load factor
ByteOpenCustomHashSet(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
ByteOpenCustomHashSet(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	add(byte o) A Type-Specific add function to reduce (un)boxing
boolean	addAll(ByteCollection c) A Type-Specific addAll function to reduce (un)boxing
boolean	addAll(java.util.Collection<? extends java.lang.Byte> c) Deprecated.
void	clear()
void	clearAndTrim(int size) Trims the collection down to the requested size and clears all elements while doing so
boolean	contains(byte o) A Type-Specific implementation of contains.
ByteOpenCustomHashSet	copy() A Function that does a shallow clone of the Collection itself.
int	count(Byte2BooleanFunction filter) Helper function to reduce stream usage that allows to count the valid elements.
byte	findFirst(Byte2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for the first match.
void	forEach(ByteConsumer action) A Type Specific foreach function that reduces (un)boxing
<E> void	forEach(E input, ObjectByteConsumer<E> action) Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
ByteStrategy	getStrategy() Helper getter function to get the current strategy
ByteIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
boolean	matchesAll(Byte2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(Byte2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(Byte2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for no matches.
byte	reduce(byte identity, ByteByteUnaryOperator operator) Performs a reduction on the elements of this Iterable
byte	reduce(ByteByteUnaryOperator operator) Performs a reduction on the elements of this Iterable
boolean	remove(byte o) A Type Specific remove function to reduce boxing/unboxing
int	size()
boolean	trim(int size) Trims the original collection down to the size of the current elements or the requested size depending which is bigger

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, containsAll, containsAny, containsAny, remByte, remove, removeAll, removeAll, retainAll, retainAll, toByteArray, toByteArray

Methods inherited from class java.util.AbstractCollection

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.utils.ITrimmable

clearAndTrim, trim

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

add, contains, remByte, remove, spliterator, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Set

containsAll, isEmpty, removeAll, retainAll, toArray, toArray

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

addAll, addAll, addAll, containsAll, containsAny, containsAny, parallelPrimitiveStream, pour, primitiveStream, remIf, removeAll, removeAll, removeIf, retainAll, retainAll, toByteArray, toByteArray

Methods inherited from interface java.util.Collection

parallelStream, stream

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

arrayflatMap, asAsync, distinct, filter, flatMap, forEach, limit, map, peek, pourAsList, pourAsSet, sorted

Constructor Detail

ByteOpenCustomHashSet

public ByteOpenCustomHashSet(ByteStrategy strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

ByteOpenCustomHashSet

public ByteOpenCustomHashSet(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

ByteOpenCustomHashSet

public ByteOpenCustomHashSet(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

ByteOpenCustomHashSet

public ByteOpenCustomHashSet(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

ByteOpenCustomHashSet

public ByteOpenCustomHashSet(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

ByteOpenCustomHashSet

public ByteOpenCustomHashSet(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

ByteOpenCustomHashSet

public ByteOpenCustomHashSet(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

ByteOpenCustomHashSet

@Deprecated
public ByteOpenCustomHashSet(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

ByteOpenCustomHashSet

@Deprecated
public ByteOpenCustomHashSet(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

ByteOpenCustomHashSet

public ByteOpenCustomHashSet(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

ByteOpenCustomHashSet

public ByteOpenCustomHashSet(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

ByteOpenCustomHashSet

public ByteOpenCustomHashSet(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

ByteOpenCustomHashSet

public ByteOpenCustomHashSet(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

ByteOpenCustomHashSet

public ByteOpenCustomHashSet(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

ByteOpenCustomHashSet

public ByteOpenCustomHashSet(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

getStrategy

public ByteStrategy getStrategy()

Helper getter function to get the current strategy

Returns:

the current strategy

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

addAll

@Deprecated
public boolean addAll(java.util.Collection<? extends java.lang.Byte> c)

Deprecated.

Description copied from class: AbstractByteCollection

This default implementation delegates to the corresponding type-specific function.

Specified by:

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

Specified by:

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

Overrides:

addAll in class AbstractByteCollection

addAll

public boolean addAll(ByteCollection c)

Description copied from interface: ByteCollection

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

Specified by:

addAll in interface ByteCollection

Overrides:

addAll in class AbstractByteCollection

Parameters:

c - the collection of elements that should be added

Returns:

true if elements were added into the collection

contains

public boolean contains(byte o)

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:

o - the element that should be searched for.

Returns:

true if the value was found.

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

trim

public boolean trim(int size)

Description copied from interface: ITrimmable

Trims the original collection down to the size of the current elements or the requested size depending which is bigger

Specified by:

trim in interface ITrimmable

Parameters:

size - the requested trim size.

Returns:

if the internal array has been trimmed.

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

Parameters:

size - the amount of elements that should be allowed

iterator

public ByteIterator 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 class AbstractByteSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

copy

public ByteOpenCustomHashSet copy()

Description copied from interface: ByteCollection

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 ByteCollection

Specified by:

copy in interface ByteSet

Overrides:

copy in class AbstractByteSet

Returns:

a Shallow Copy of the collection

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>

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)

forEach

public <E> void forEach(E input,
                        ObjectByteConsumer<E> action)

Description copied from interface: ByteIterable

Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.

Specified by:

forEach in interface ByteIterable

Type Parameters:

E - the generic type of the Object

Parameters:

input - the object that should be included

action - The action to be performed for each element

matchesAny

public boolean matchesAny(Byte2BooleanFunction filter)

Description copied from interface: ByteIterable

Helper function to reduce stream usage that allows to filter for any matches.

Specified by:

matchesAny in interface ByteIterable

Parameters:

filter - that should be applied

Returns:

true if any matches were found

matchesNone

public boolean matchesNone(Byte2BooleanFunction filter)

Description copied from interface: ByteIterable

Helper function to reduce stream usage that allows to filter for no matches.

Specified by:

matchesNone in interface ByteIterable

Parameters:

filter - that should be applied

Returns:

true if no matches were found

matchesAll

public boolean matchesAll(Byte2BooleanFunction filter)

Description copied from interface: ByteIterable

Helper function to reduce stream usage that allows to filter for all matches.

Specified by:

matchesAll in interface ByteIterable

Parameters:

filter - that should be applied

Returns:

true if all matches.

reduce

public byte reduce(byte identity,
                   ByteByteUnaryOperator operator)

Description copied from interface: ByteIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface ByteIterable

Parameters:

identity - the start value

operator - the operation that should be applied

Returns:

the reduction result, returns identity if nothing was found

reduce

public byte reduce(ByteByteUnaryOperator operator)

Description copied from interface: ByteIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface ByteIterable

Parameters:

operator - the operation that should be applied

Returns:

the reduction result, returns null value if nothing was found

findFirst

public byte findFirst(Byte2BooleanFunction filter)

Description copied from interface: ByteIterable

Helper function to reduce stream usage that allows to filter for the first match.

Specified by:

findFirst in interface ByteIterable

Parameters:

filter - that should be applied

Returns:

the found value or the null equivalent variant.

count

public int count(Byte2BooleanFunction filter)

Description copied from interface: ByteIterable

Helper function to reduce stream usage that allows to count the valid elements.

Specified by:

count in interface ByteIterable

Parameters:

filter - that should be applied

Returns:

the amount of Valid Elements