speiger.src.collections.chars.sets

Class CharLinkedOpenCustomHashSet

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

speiger.src.collections.chars.sets.CharLinkedOpenCustomHashSet

All Implemented Interfaces:

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

public class CharLinkedOpenCustomHashSet
extends CharOpenCustomHashSet
implements CharSortedSet

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

Constructor Summary

Constructors

Constructor and Description
CharLinkedOpenCustomHashSet(char[] array, CharStrategy strategy) Helper constructor that allow to create a set from unboxed values
CharLinkedOpenCustomHashSet(char[] array, float loadFactor, CharStrategy strategy) Helper constructor that allow to create a set from unboxed values
CharLinkedOpenCustomHashSet(char[] array, int offset, int length, CharStrategy strategy) Helper constructor that allow to create a set from unboxed values
CharLinkedOpenCustomHashSet(char[] array, int offset, int length, float loadFactor, CharStrategy strategy) Helper constructor that allow to create a set from unboxed values
CharLinkedOpenCustomHashSet(CharCollection collection, CharStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
CharLinkedOpenCustomHashSet(CharCollection collection, float loadFactor, CharStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
CharLinkedOpenCustomHashSet(CharIterator iterator, CharStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
CharLinkedOpenCustomHashSet(CharIterator iterator, float loadFactor, CharStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
CharLinkedOpenCustomHashSet(CharStrategy strategy) Default Contstructor
CharLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Character> collection, CharStrategy strategy) Deprecated.
CharLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Character> collection, float loadFactor, CharStrategy strategy) Deprecated.
CharLinkedOpenCustomHashSet(int minCapacity, CharStrategy strategy) Constructor that defines the minimum capacity
CharLinkedOpenCustomHashSet(int minCapacity, float loadFactor, CharStrategy strategy) Constructor that defines the minimum capacity and load factor
CharLinkedOpenCustomHashSet(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
CharLinkedOpenCustomHashSet(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	addAndMoveToFirst(char o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(char 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
CharComparator	comparator() A Type Specific Comparator method
char	firstChar() A method to get the first element in the set
CharSortedSet	headSet(char toElement) A Type Specific HeadSet method to reduce boxing/unboxing
CharListIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
CharBidirectionalIterator	iterator(char fromElement) A type Specific Iterator starting from a given key
char	lastChar() A method to get the last element in the set
boolean	moveToFirst(char o) A specific move method to move a given key to the first index.
boolean	moveToLast(char o) A specific move method to move a given key to the last index.
char	pollFirstChar() A method to get and remove the first element in the set
char	pollLastChar() A method to get and remove the last element in the set
CharSortedSet	subSet(char fromElement, char toElement) A Type Specific SubSet method to reduce boxing/unboxing
CharSortedSet	tailSet(char fromElement) A Type Specific TailSet method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.chars.sets.CharOpenCustomHashSet

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

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

first, headSet, last, spliterator, subSet, tailSet

Methods inherited from interface speiger.src.collections.chars.sets.CharSet

add, contains, remChar, remove, remove

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

add, addAll, contains, containsAll, containsAny, containsAny, parallelPrimitiveStream, primitiveStream, remIf, removeAll, removeIf, retainAll, toCharArray, toCharArray

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

forEach, forEach

Methods inherited from interface java.util.Set

addAll, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, stream

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

clearAndTrim, trim

Constructor Detail

CharLinkedOpenCustomHashSet

public CharLinkedOpenCustomHashSet(CharStrategy strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

CharLinkedOpenCustomHashSet

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

CharLinkedOpenCustomHashSet

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

CharLinkedOpenCustomHashSet

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

CharLinkedOpenCustomHashSet

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

CharLinkedOpenCustomHashSet

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

CharLinkedOpenCustomHashSet

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

CharLinkedOpenCustomHashSet

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

CharLinkedOpenCustomHashSet

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

CharLinkedOpenCustomHashSet

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

CharLinkedOpenCustomHashSet

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

CharLinkedOpenCustomHashSet

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

CharLinkedOpenCustomHashSet

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

CharLinkedOpenCustomHashSet

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

CharLinkedOpenCustomHashSet

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

addAndMoveToFirst

public boolean addAndMoveToFirst(char o)

Description copied from interface: CharSortedSet

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

Specified by:

addAndMoveToFirst in interface CharSortedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

addAndMoveToLast

public boolean addAndMoveToLast(char o)

Description copied from interface: CharSortedSet

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

Specified by:

addAndMoveToLast in interface CharSortedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

moveToFirst

public boolean moveToFirst(char o)

Description copied from interface: CharSortedSet

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

Specified by:

moveToFirst in interface CharSortedSet

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(char o)

Description copied from interface: CharSortedSet

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

Specified by:

moveToLast in interface CharSortedSet

Parameters:

o - that should be moved to the first last

Returns:

true if the value was moved.

firstChar

public char firstChar()

Description copied from interface: CharSortedSet

A method to get the first element in the set

Specified by:

firstChar in interface CharSortedSet

Returns:

first element in the set

pollFirstChar

public char pollFirstChar()

Description copied from interface: CharSortedSet

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

Specified by:

pollFirstChar in interface CharSortedSet

Returns:

first element in the set

lastChar

public char lastChar()

Description copied from interface: CharSortedSet

A method to get the last element in the set

Specified by:

lastChar in interface CharSortedSet

Returns:

last element in the set

pollLastChar

public char pollLastChar()

Description copied from interface: CharSortedSet

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

Specified by:

pollLastChar in interface CharSortedSet

Returns:

last element in the set

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 CharOpenCustomHashSet

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 CharOpenCustomHashSet

Parameters:

size - the amount of elements that should be allowed

iterator

public CharListIterator 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 interface CharSortedSet

Overrides:

iterator in class CharOpenCustomHashSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

public CharBidirectionalIterator iterator(char fromElement)

Description copied from interface: CharSortedSet

A type Specific Iterator starting from a given key

Specified by:

iterator in interface CharSortedSet

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

comparator

public CharComparator comparator()

Description copied from interface: CharSortedSet

A Type Specific Comparator method

Specified by:

comparator in interface java.util.SortedSet<java.lang.Character>

Specified by:

comparator in interface CharSortedSet

Returns:

the type specific comparator

subSet

public CharSortedSet subSet(char fromElement,
                            char toElement)

Description copied from interface: CharSortedSet

A Type Specific SubSet method to reduce boxing/unboxing

Specified by:

subSet in interface CharSortedSet

Parameters:

fromElement - where the SubSet should start

toElement - where the SubSet should end

Returns:

a SubSet that is within the range of the desired range

headSet

public CharSortedSet headSet(char toElement)

Description copied from interface: CharSortedSet

A Type Specific HeadSet method to reduce boxing/unboxing

Specified by:

headSet in interface CharSortedSet

Parameters:

toElement - where the HeadSet should end

Returns:

a HeadSet that is within the range of the desired range

tailSet

public CharSortedSet tailSet(char fromElement)

Description copied from interface: CharSortedSet

A Type Specific TailSet method to reduce boxing/unboxing

Specified by:

tailSet in interface CharSortedSet

Parameters:

fromElement - where the TailSet should start

Returns:

a TailSet that is within the range of the desired range