speiger.src.collections.objects.sets

Class ObjectLinkedOpenCustomHashSet<T>

java.lang.Object

java.util.AbstractCollection<T>

speiger.src.collections.objects.collections.AbstractObjectCollection<T>

speiger.src.collections.objects.sets.AbstractObjectSet<T>

speiger.src.collections.objects.sets.ObjectOpenCustomHashSet<T>

speiger.src.collections.objects.sets.ObjectLinkedOpenCustomHashSet<T>

Type Parameters:

T - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.Set<T>, ObjectCollection<T>, ObjectIterable<T>, ObjectOrderedSet<T>, ObjectSet<T>, ISizeProvider, ITrimmable

public class ObjectLinkedOpenCustomHashSet<T>
extends ObjectOpenCustomHashSet<T>
implements ObjectOrderedSet<T>

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

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.utils.ISizeProvider

ISizeProvider.CollectionSize

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	addAndMoveToFirst(T o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(T 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
ObjectLinkedOpenCustomHashSet<T>	copy() A Function that does a shallow clone of the Collection itself.
int	count(java.util.function.Predicate<T> filter) Helper function to reduce stream usage that allows to count the valid elements.
T	findFirst(java.util.function.Predicate<T> filter) Helper function to reduce stream usage that allows to filter for the first match.
T	first() A method to get the first element in the set
void	forEach(java.util.function.Consumer<? super T> action)
<E> void	forEach(E input, ObjectObjectConsumer<E,T> action) Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
void	forEachIndexed(IntObjectConsumer<T> action) A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
ObjectListIterator<T>	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
ObjectBidirectionalIterator<T>	iterator(T fromElement) A type Specific Iterator starting from a given key
T	last() A method to get the last element in the set
boolean	matchesAll(java.util.function.Predicate<T> filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(java.util.function.Predicate<T> filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(java.util.function.Predicate<T> filter) Helper function to reduce stream usage that allows to filter for no matches.
boolean	moveToFirst(T o) A specific move method to move a given key to the first index.
boolean	moveToLast(T o) A specific move method to move a given key to the last index.
T	pollFirst() A method to get and remove the first element in the set
T	pollLast() A method to get and remove the last element in the set
<E> E	reduce(E identity, java.util.function.BiFunction<E,T,E> operator) Performs a reduction on the elements of this Iterable
T	reduce(ObjectObjectUnaryOperator<T,T> operator) Performs a reduction on the elements of this Iterable

Methods inherited from class speiger.src.collections.objects.sets.ObjectOpenCustomHashSet

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

Methods inherited from class speiger.src.collections.objects.sets.AbstractObjectSet

equals, hashCode

Methods inherited from class speiger.src.collections.objects.collections.AbstractObjectCollection

containsAll, containsAll, containsAny, containsAny, removeAll, removeAll, retainAll, retainAll

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.objects.sets.ObjectOrderedSet

spliterator, synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.objects.sets.ObjectSet

addOrGet

Methods inherited from interface java.util.Set

add, addAll, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface speiger.src.collections.objects.collections.ObjectCollection

addAll, addAll, addAll, addAll, containsAll, containsAny, containsAny, pour, removeAll, removeAll, retainAll, retainAll, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface speiger.src.collections.objects.collections.ObjectIterable

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

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

of, size

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

clearAndTrim, trim

Constructor Detail

ObjectLinkedOpenCustomHashSet

public ObjectLinkedOpenCustomHashSet(ObjectStrategy<? super T> strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

ObjectLinkedOpenCustomHashSet

public ObjectLinkedOpenCustomHashSet(int minCapacity,
                                     ObjectStrategy<? super T> 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

ObjectLinkedOpenCustomHashSet

public ObjectLinkedOpenCustomHashSet(int minCapacity,
                                     float loadFactor,
                                     ObjectStrategy<? super T> 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

ObjectLinkedOpenCustomHashSet

public ObjectLinkedOpenCustomHashSet(T[] array,
                                     ObjectStrategy<? super T> 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

ObjectLinkedOpenCustomHashSet

public ObjectLinkedOpenCustomHashSet(T[] array,
                                     float loadFactor,
                                     ObjectStrategy<? super T> 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

ObjectLinkedOpenCustomHashSet

public ObjectLinkedOpenCustomHashSet(T[] array,
                                     int offset,
                                     int length,
                                     ObjectStrategy<? super T> 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

ObjectLinkedOpenCustomHashSet

public ObjectLinkedOpenCustomHashSet(T[] array,
                                     int offset,
                                     int length,
                                     float loadFactor,
                                     ObjectStrategy<? super T> 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

ObjectLinkedOpenCustomHashSet

public ObjectLinkedOpenCustomHashSet(java.util.Collection<? extends T> collection,
                                     ObjectStrategy<? super T> 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

ObjectLinkedOpenCustomHashSet

public ObjectLinkedOpenCustomHashSet(java.util.Collection<? extends T> collection,
                                     float loadFactor,
                                     ObjectStrategy<? super T> 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

ObjectLinkedOpenCustomHashSet

public ObjectLinkedOpenCustomHashSet(ObjectCollection<T> collection,
                                     ObjectStrategy<? super T> 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

ObjectLinkedOpenCustomHashSet

public ObjectLinkedOpenCustomHashSet(ObjectCollection<T> collection,
                                     float loadFactor,
                                     ObjectStrategy<? super T> 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

ObjectLinkedOpenCustomHashSet

public ObjectLinkedOpenCustomHashSet(java.util.Iterator<T> iterator,
                                     ObjectStrategy<? super T> 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

ObjectLinkedOpenCustomHashSet

public ObjectLinkedOpenCustomHashSet(java.util.Iterator<T> iterator,
                                     float loadFactor,
                                     ObjectStrategy<? super T> 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(T o)

Description copied from interface: ObjectOrderedSet

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

Specified by:

addAndMoveToFirst in interface ObjectOrderedSet<T>

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

addAndMoveToLast

public boolean addAndMoveToLast(T o)

Description copied from interface: ObjectOrderedSet

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

Specified by:

addAndMoveToLast in interface ObjectOrderedSet<T>

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

moveToFirst

public boolean moveToFirst(T o)

Description copied from interface: ObjectOrderedSet

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

Specified by:

moveToFirst in interface ObjectOrderedSet<T>

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(T o)

Description copied from interface: ObjectOrderedSet

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

Specified by:

moveToLast in interface ObjectOrderedSet<T>

Parameters:

o - that should be moved to the first last

Returns:

true if the value was moved.

first

public T first()

Description copied from interface: ObjectOrderedSet

A method to get the first element in the set

Specified by:

first in interface ObjectOrderedSet<T>

Returns:

first element in the set

pollFirst

public T pollFirst()

Description copied from interface: ObjectOrderedSet

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

Specified by:

pollFirst in interface ObjectOrderedSet<T>

Returns:

first element in the set

last

public T last()

Description copied from interface: ObjectOrderedSet

A method to get the last element in the set

Specified by:

last in interface ObjectOrderedSet<T>

Returns:

last element in the set

pollLast

public T pollLast()

Description copied from interface: ObjectOrderedSet

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

Specified by:

pollLast in interface ObjectOrderedSet<T>

Returns:

last element in the set

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

Specified by:

clear in interface java.util.Set<T>

Overrides:

clear in class ObjectOpenCustomHashSet<T>

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 ObjectOpenCustomHashSet<T>

Parameters:

size - the amount of elements that should be allowed

forEach

public void forEach(java.util.function.Consumer<? super T> action)

Specified by:

forEach in interface java.lang.Iterable<T>

Overrides:

forEach in class ObjectOpenCustomHashSet<T>

forEachIndexed

public void forEachIndexed(IntObjectConsumer<T> action)

Description copied from interface: ObjectIterable

A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.

Specified by:

forEachIndexed in interface ObjectIterable<T>

Overrides:

forEachIndexed in class ObjectOpenCustomHashSet<T>

Parameters:

action - The action to be performed for each element

forEach

public <E> void forEach(E input,
                        ObjectObjectConsumer<E,T> action)

Description copied from interface: ObjectIterable

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

Specified by:

forEach in interface ObjectIterable<T>

Overrides:

forEach in class ObjectOpenCustomHashSet<T>

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(java.util.function.Predicate<T> filter)

Description copied from interface: ObjectIterable

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

Specified by:

matchesAny in interface ObjectIterable<T>

Overrides:

matchesAny in class ObjectOpenCustomHashSet<T>

Parameters:

filter - that should be applied

Returns:

true if any matches were found

matchesNone

public boolean matchesNone(java.util.function.Predicate<T> filter)

Description copied from interface: ObjectIterable

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

Specified by:

matchesNone in interface ObjectIterable<T>

Overrides:

matchesNone in class ObjectOpenCustomHashSet<T>

Parameters:

filter - that should be applied

Returns:

true if no matches were found

matchesAll

public boolean matchesAll(java.util.function.Predicate<T> filter)

Description copied from interface: ObjectIterable

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

Specified by:

matchesAll in interface ObjectIterable<T>

Overrides:

matchesAll in class ObjectOpenCustomHashSet<T>

Parameters:

filter - that should be applied

Returns:

true if all matches.

reduce

public <E> E reduce(E identity,
                    java.util.function.BiFunction<E,T,E> operator)

Description copied from interface: ObjectIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface ObjectIterable<T>

Overrides:

reduce in class ObjectOpenCustomHashSet<T>

Type Parameters:

E - the keyType of elements maintained by this Collection

Parameters:

identity - the start value

operator - the operation that should be applied

Returns:

the reduction result, returns identity if nothing was found

reduce

public T reduce(ObjectObjectUnaryOperator<T,T> operator)

Description copied from interface: ObjectIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface ObjectIterable<T>

Overrides:

reduce in class ObjectOpenCustomHashSet<T>

Parameters:

operator - the operation that should be applied

Returns:

the reduction result, returns null value if nothing was found

findFirst

public T findFirst(java.util.function.Predicate<T> filter)

Description copied from interface: ObjectIterable

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

Specified by:

findFirst in interface ObjectIterable<T>

Overrides:

findFirst in class ObjectOpenCustomHashSet<T>

Parameters:

filter - that should be applied

Returns:

the found value or the null equivalent variant.

count

public int count(java.util.function.Predicate<T> filter)

Description copied from interface: ObjectIterable

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

Specified by:

count in interface ObjectIterable<T>

Overrides:

count in class ObjectOpenCustomHashSet<T>

Parameters:

filter - that should be applied

Returns:

the amount of Valid Elements

iterator

public ObjectListIterator<T> iterator()

Description copied from interface: ObjectCollection

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

Specified by:

iterator in interface java.lang.Iterable<T>

Specified by:

iterator in interface java.util.Collection<T>

Specified by:

iterator in interface java.util.Set<T>

Specified by:

iterator in interface ObjectCollection<T>

Specified by:

iterator in interface ObjectIterable<T>

Specified by:

iterator in interface ObjectOrderedSet<T>

Specified by:

iterator in interface ObjectSet<T>

Overrides:

iterator in class ObjectOpenCustomHashSet<T>

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

public ObjectBidirectionalIterator<T> iterator(T fromElement)

Description copied from interface: ObjectOrderedSet

A type Specific Iterator starting from a given key

Specified by:

iterator in interface ObjectOrderedSet<T>

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

copy

public ObjectLinkedOpenCustomHashSet<T> copy()

Description copied from interface: ObjectCollection

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 ObjectCollection<T>

Specified by:

copy in interface ObjectOrderedSet<T>

Specified by:

copy in interface ObjectSet<T>

Overrides:

copy in class ObjectOpenCustomHashSet<T>

Returns:

a Shallow Copy of the collection