speiger.src.collections.chars.sets

Class CharOpenCustomHashSet

java.lang.Object

java.util.AbstractCollection<java.lang.Character>

speiger.src.collections.chars.collections.AbstractCharCollection

speiger.src.collections.chars.sets.AbstractCharSet

speiger.src.collections.chars.sets.CharOpenCustomHashSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Character>, java.util.Collection<java.lang.Character>, java.util.Set<java.lang.Character>, CharCollection, CharIterable, CharSet, ITrimmable

Direct Known Subclasses:

CharLinkedOpenCustomHashSet

public class CharOpenCustomHashSet
extends AbstractCharSet
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
CharOpenCustomHashSet(char[] array, CharStrategy strategy) Helper constructor that allow to create a set from unboxed values
CharOpenCustomHashSet(char[] array, float loadFactor, CharStrategy strategy) Helper constructor that allow to create a set from unboxed values
CharOpenCustomHashSet(char[] array, int offset, int length, CharStrategy strategy) Helper constructor that allow to create a set from unboxed values
CharOpenCustomHashSet(char[] array, int offset, int length, float loadFactor, CharStrategy strategy) Helper constructor that allow to create a set from unboxed values
CharOpenCustomHashSet(CharCollection collection, CharStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
CharOpenCustomHashSet(CharCollection collection, float loadFactor, CharStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
CharOpenCustomHashSet(CharIterator iterator, CharStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
CharOpenCustomHashSet(CharIterator iterator, float loadFactor, CharStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
CharOpenCustomHashSet(CharStrategy strategy) Default Contstructor
CharOpenCustomHashSet(java.util.Collection<? extends java.lang.Character> collection, CharStrategy strategy) Deprecated.
CharOpenCustomHashSet(java.util.Collection<? extends java.lang.Character> collection, float loadFactor, CharStrategy strategy) Deprecated.
CharOpenCustomHashSet(int minCapacity, CharStrategy strategy) Constructor that defines the minimum capacity
CharOpenCustomHashSet(int minCapacity, float loadFactor, CharStrategy strategy) Constructor that defines the minimum capacity and load factor
CharOpenCustomHashSet(java.util.Iterator<java.lang.Character> iterator, CharStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
CharOpenCustomHashSet(java.util.Iterator<java.lang.Character> iterator, float loadFactor, CharStrategy 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(char o) A Type-Specific add function to reduce (un)boxing
boolean	addAll(CharCollection c) A Type-Specific addAll function to reduce (un)boxing
boolean	addAll(java.util.Collection<? extends java.lang.Character> 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(char o) A Type-Specific implementation of contains.
CharStrategy	getStrategy() Helper getter function to get the current strategy
CharIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
boolean	remove(char 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.chars.sets.AbstractCharSet

equals, hashCode

Methods inherited from class speiger.src.collections.chars.collections.AbstractCharCollection

add, contains, containsAll, containsAny, containsAny, remChar, remove, removeAll, retainAll, toCharArray, toCharArray

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.chars.sets.CharSet

add, contains, remChar, remove, spliterator

Methods inherited from interface java.util.Set

containsAll, isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from interface speiger.src.collections.chars.collections.CharCollection

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

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface speiger.src.collections.chars.collections.CharIterable

forEach, forEach

Constructor Detail

CharOpenCustomHashSet

public CharOpenCustomHashSet(CharStrategy strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

CharOpenCustomHashSet

public CharOpenCustomHashSet(int minCapacity,
                             CharStrategy 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

CharOpenCustomHashSet

public CharOpenCustomHashSet(int minCapacity,
                             float loadFactor,
                             CharStrategy 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

CharOpenCustomHashSet

public CharOpenCustomHashSet(char[] array,
                             CharStrategy 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

CharOpenCustomHashSet

public CharOpenCustomHashSet(char[] array,
                             float loadFactor,
                             CharStrategy 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

CharOpenCustomHashSet

public CharOpenCustomHashSet(char[] array,
                             int offset,
                             int length,
                             CharStrategy 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

CharOpenCustomHashSet

public CharOpenCustomHashSet(char[] array,
                             int offset,
                             int length,
                             float loadFactor,
                             CharStrategy 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

CharOpenCustomHashSet

@Deprecated
public CharOpenCustomHashSet(java.util.Collection<? extends java.lang.Character> collection,
                                          CharStrategy 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

CharOpenCustomHashSet

@Deprecated
public CharOpenCustomHashSet(java.util.Collection<? extends java.lang.Character> collection,
                                          float loadFactor,
                                          CharStrategy 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

CharOpenCustomHashSet

public CharOpenCustomHashSet(CharCollection collection,
                             CharStrategy 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

CharOpenCustomHashSet

public CharOpenCustomHashSet(CharCollection collection,
                             float loadFactor,
                             CharStrategy 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

CharOpenCustomHashSet

public CharOpenCustomHashSet(java.util.Iterator<java.lang.Character> iterator,
                             CharStrategy 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

CharOpenCustomHashSet

public CharOpenCustomHashSet(java.util.Iterator<java.lang.Character> iterator,
                             float loadFactor,
                             CharStrategy 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

CharOpenCustomHashSet

public CharOpenCustomHashSet(CharIterator iterator,
                             CharStrategy 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

CharOpenCustomHashSet

public CharOpenCustomHashSet(CharIterator iterator,
                             float loadFactor,
                             CharStrategy 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 CharStrategy getStrategy()

Helper getter function to get the current strategy

Returns:

the current strategy

add

public boolean add(char o)

Description copied from interface: CharCollection

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

Specified by:

add in interface CharCollection

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

Deprecated.

Description copied from class: AbstractCharCollection

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

Specified by:

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

Specified by:

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

Overrides:

addAll in class AbstractCharCollection

addAll

public boolean addAll(CharCollection c)

Description copied from interface: CharCollection

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

Specified by:

addAll in interface CharCollection

Overrides:

addAll in class AbstractCharCollection

Parameters:

c - the collection of elements that should be added

Returns:

true if elements were added into the collection

contains

public boolean contains(char o)

Description copied from class: AbstractCharCollection

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

Specified by:

contains in interface CharCollection

Overrides:

contains in class AbstractCharCollection

Parameters:

o - the element that should be searched for.

Returns:

true if the value was found.

remove

public boolean remove(char o)

Description copied from interface: CharSet

A Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface CharSet

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

Description copied from interface: CharCollection

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface CharCollection

Specified by:

iterator in interface CharIterable

Specified by:

iterator in interface CharSet

Specified by:

iterator in class AbstractCharSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

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

size

public int size()

Specified by:

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

Specified by:

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

Specified by:

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