speiger.src.collections.objects.sets

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

Type Parameters:

T - the type 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>, ObjectSet<T>, ITrimmable

Direct Known Subclasses:

ObjectLinkedOpenCustomHashSet

public class ObjectOpenCustomHashSet<T>
extends AbstractObjectSet<T>
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
ObjectOpenCustomHashSet(java.util.Collection<? extends T> collection, float loadFactor, ObjectStrategy<? super T> strategy) Deprecated.
ObjectOpenCustomHashSet(java.util.Collection<? extends T> collection, ObjectStrategy<? super T> strategy) Deprecated.
ObjectOpenCustomHashSet(int minCapacity, float loadFactor, ObjectStrategy<? super T> strategy) Constructor that defines the minimum capacity and load factor
ObjectOpenCustomHashSet(int minCapacity, ObjectStrategy<? super T> strategy) Constructor that defines the minimum capacity
ObjectOpenCustomHashSet(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
ObjectOpenCustomHashSet(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
ObjectOpenCustomHashSet(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.
ObjectOpenCustomHashSet(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.
ObjectOpenCustomHashSet(ObjectStrategy<? super T> strategy) Default Contstructor
ObjectOpenCustomHashSet(T[] array, float loadFactor, ObjectStrategy<? super T> strategy) Helper constructor that allow to create a set from unboxed values
ObjectOpenCustomHashSet(T[] array, int offset, int length, float loadFactor, ObjectStrategy<? super T> strategy) Helper constructor that allow to create a set from unboxed values
ObjectOpenCustomHashSet(T[] array, int offset, int length, ObjectStrategy<? super T> strategy) Helper constructor that allow to create a set from unboxed values
ObjectOpenCustomHashSet(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	add(T o)
boolean	addAll(java.util.Collection<? extends T> c) Deprecated.
boolean	addAll(ObjectCollection<T> 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(java.lang.Object o)
ObjectStrategy<? super T>	getStrategy() Helper getter function to get the current strategy
ObjectIterator<T>	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
boolean	remove(java.lang.Object o)
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.objects.sets.AbstractObjectSet

equals, hashCode

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

containsAll, containsAny, containsAny, removeAll, retainAll

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

spliterator

Methods inherited from interface java.util.Set

containsAll, isEmpty, removeAll, retainAll, toArray, toArray

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

containsAll, containsAny, containsAny, removeAll, retainAll

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ObjectOpenCustomHashSet

public ObjectOpenCustomHashSet(ObjectStrategy<? super T> strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

ObjectOpenCustomHashSet

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

ObjectOpenCustomHashSet

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

ObjectOpenCustomHashSet

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

ObjectOpenCustomHashSet

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

ObjectOpenCustomHashSet

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

ObjectOpenCustomHashSet

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

ObjectOpenCustomHashSet

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

ObjectOpenCustomHashSet

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

ObjectOpenCustomHashSet

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

ObjectOpenCustomHashSet

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

ObjectOpenCustomHashSet

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

ObjectOpenCustomHashSet

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

getStrategy

public ObjectStrategy<? super T> getStrategy()

Helper getter function to get the current strategy

Returns:

the current strategy

add

public boolean add(T o)

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface java.util.Set<T>

Overrides:

add in class java.util.AbstractCollection<T>

addAll

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

Deprecated.

Description copied from class: AbstractObjectCollection

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

Specified by:

addAll in interface java.util.Collection<T>

Specified by:

addAll in interface java.util.Set<T>

Overrides:

addAll in class AbstractObjectCollection<T>

addAll

public boolean addAll(ObjectCollection<T> c)

Description copied from interface: ObjectCollection

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

Specified by:

addAll in interface ObjectCollection<T>

Overrides:

addAll in class AbstractObjectCollection<T>

Parameters:

c - the collection of elements that should be added

Returns:

true if elements were added into the collection

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<T>

Specified by:

contains in interface java.util.Set<T>

Overrides:

contains in class java.util.AbstractCollection<T>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<T>

Specified by:

remove in interface java.util.Set<T>

Overrides:

remove in class java.util.AbstractCollection<T>

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 ObjectIterator<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 ObjectSet<T>

Specified by:

iterator in class AbstractObjectSet<T>

Returns:

a iterator of the collection

See Also:

Collection.iterator()

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 java.util.AbstractCollection<T>

size

public int size()

Specified by:

size in interface java.util.Collection<T>

Specified by:

size in interface java.util.Set<T>

Specified by:

size in class java.util.AbstractCollection<T>