speiger.src.collections.longs.sets

Class LongOpenCustomHashSet

java.lang.Object

java.util.AbstractCollection<java.lang.Long>

speiger.src.collections.longs.collections.AbstractLongCollection

speiger.src.collections.longs.sets.AbstractLongSet

speiger.src.collections.longs.sets.LongOpenCustomHashSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Long>, java.util.Collection<java.lang.Long>, java.util.Set<java.lang.Long>, LongCollection, LongIterable, LongSet, ITrimmable

Direct Known Subclasses:

LongLinkedOpenCustomHashSet

public class LongOpenCustomHashSet
extends AbstractLongSet
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
LongOpenCustomHashSet(java.util.Collection<? extends java.lang.Long> collection, float loadFactor, LongStrategy strategy) Deprecated.
LongOpenCustomHashSet(java.util.Collection<? extends java.lang.Long> collection, LongStrategy strategy) Deprecated.
LongOpenCustomHashSet(int minCapacity, float loadFactor, LongStrategy strategy) Constructor that defines the minimum capacity and load factor
LongOpenCustomHashSet(int minCapacity, LongStrategy strategy) Constructor that defines the minimum capacity
LongOpenCustomHashSet(java.util.Iterator<java.lang.Long> iterator, float loadFactor, LongStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
LongOpenCustomHashSet(java.util.Iterator<java.lang.Long> iterator, LongStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
LongOpenCustomHashSet(long[] array, float loadFactor, LongStrategy strategy) Helper constructor that allow to create a set from unboxed values
LongOpenCustomHashSet(long[] array, int offset, int length, float loadFactor, LongStrategy strategy) Helper constructor that allow to create a set from unboxed values
LongOpenCustomHashSet(long[] array, int offset, int length, LongStrategy strategy) Helper constructor that allow to create a set from unboxed values
LongOpenCustomHashSet(long[] array, LongStrategy strategy) Helper constructor that allow to create a set from unboxed values
LongOpenCustomHashSet(LongCollection collection, float loadFactor, LongStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
LongOpenCustomHashSet(LongCollection collection, LongStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
LongOpenCustomHashSet(LongIterator iterator, float loadFactor, LongStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
LongOpenCustomHashSet(LongIterator iterator, LongStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
LongOpenCustomHashSet(LongStrategy strategy) Default Contstructor

Method Summary

Modifier and Type	Method and Description
boolean	add(long o) A Type-Specific add function to reduce (un)boxing
boolean	addAll(java.util.Collection<? extends java.lang.Long> c) Deprecated.
boolean	addAll(LongCollection c) A Type-Specific addAll function to reduce (un)boxing
void	clear()
void	clearAndTrim(int size) Trims the collection down to the requested size and clears all elements while doing so
boolean	contains(long o) A Type-Specific implementation of contains.
LongStrategy	getStrategy() Helper getter function to get the current strategy
LongIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
boolean	remove(long 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.longs.sets.AbstractLongSet

equals, hashCode

Methods inherited from class speiger.src.collections.longs.collections.AbstractLongCollection

add, contains, containsAll, containsAny, containsAny, remLong, remove, removeAll, retainAll, toLongArray, toLongArray

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

clearAndTrim, trim

Methods inherited from interface speiger.src.collections.longs.sets.LongSet

add, contains, remLong, remove, spliterator

Methods inherited from interface java.util.Set

containsAll, isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from interface speiger.src.collections.longs.collections.LongCollection

containsAll, containsAny, containsAny, parallelPrimitiveStream, primitiveStream, remIf, removeAll, removeIf, retainAll, toLongArray, toLongArray

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface speiger.src.collections.longs.collections.LongIterable

forEach, forEach

Constructor Detail

LongOpenCustomHashSet

public LongOpenCustomHashSet(LongStrategy strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

LongOpenCustomHashSet

public LongOpenCustomHashSet(int minCapacity,
                             LongStrategy 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

LongOpenCustomHashSet

public LongOpenCustomHashSet(int minCapacity,
                             float loadFactor,
                             LongStrategy 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

LongOpenCustomHashSet

public LongOpenCustomHashSet(long[] array,
                             LongStrategy 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

LongOpenCustomHashSet

public LongOpenCustomHashSet(long[] array,
                             float loadFactor,
                             LongStrategy 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

LongOpenCustomHashSet

public LongOpenCustomHashSet(long[] array,
                             int offset,
                             int length,
                             LongStrategy 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

LongOpenCustomHashSet

public LongOpenCustomHashSet(long[] array,
                             int offset,
                             int length,
                             float loadFactor,
                             LongStrategy 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

LongOpenCustomHashSet

@Deprecated
public LongOpenCustomHashSet(java.util.Collection<? extends java.lang.Long> collection,
                                          LongStrategy 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

LongOpenCustomHashSet

@Deprecated
public LongOpenCustomHashSet(java.util.Collection<? extends java.lang.Long> collection,
                                          float loadFactor,
                                          LongStrategy 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

LongOpenCustomHashSet

public LongOpenCustomHashSet(LongCollection collection,
                             LongStrategy 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

LongOpenCustomHashSet

public LongOpenCustomHashSet(LongCollection collection,
                             float loadFactor,
                             LongStrategy 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

LongOpenCustomHashSet

public LongOpenCustomHashSet(java.util.Iterator<java.lang.Long> iterator,
                             LongStrategy 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

LongOpenCustomHashSet

public LongOpenCustomHashSet(java.util.Iterator<java.lang.Long> iterator,
                             float loadFactor,
                             LongStrategy 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

LongOpenCustomHashSet

public LongOpenCustomHashSet(LongIterator iterator,
                             LongStrategy 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

LongOpenCustomHashSet

public LongOpenCustomHashSet(LongIterator iterator,
                             float loadFactor,
                             LongStrategy 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 LongStrategy getStrategy()

Helper getter function to get the current strategy

Returns:

the current strategy

add

public boolean add(long o)

Description copied from interface: LongCollection

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

Specified by:

add in interface LongCollection

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.Long> c)

Deprecated.

Description copied from class: AbstractLongCollection

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

Specified by:

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

Specified by:

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

Overrides:

addAll in class AbstractLongCollection

addAll

public boolean addAll(LongCollection c)

Description copied from interface: LongCollection

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

Specified by:

addAll in interface LongCollection

Overrides:

addAll in class AbstractLongCollection

Parameters:

c - the collection of elements that should be added

Returns:

true if elements were added into the collection

contains

public boolean contains(long o)

Description copied from class: AbstractLongCollection

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

Specified by:

contains in interface LongCollection

Overrides:

contains in class AbstractLongCollection

Parameters:

o - the element that should be searched for.

Returns:

true if the value was found.

remove

public boolean remove(long o)

Description copied from interface: LongSet

A Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface LongSet

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 LongIterator iterator()

Description copied from interface: LongCollection

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface LongCollection

Specified by:

iterator in interface LongIterable

Specified by:

iterator in interface LongSet

Specified by:

iterator in class AbstractLongSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

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

size

public int size()

Specified by:

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

Specified by:

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

Specified by:

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