speiger.src.collections.ints.sets

Class IntLinkedOpenCustomHashSet

java.lang.Object

java.util.AbstractCollection<java.lang.Integer>

speiger.src.collections.ints.collections.AbstractIntCollection

speiger.src.collections.ints.sets.AbstractIntSet

speiger.src.collections.ints.sets.IntOpenCustomHashSet

speiger.src.collections.ints.sets.IntLinkedOpenCustomHashSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Integer>, java.util.Collection<java.lang.Integer>, java.util.Set<java.lang.Integer>, java.util.SortedSet<java.lang.Integer>, IntCollection, IntIterable, IntSet, IntSortedSet, ITrimmable

public class IntLinkedOpenCustomHashSet
extends IntOpenCustomHashSet
implements IntSortedSet

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
IntLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Integer> collection, float loadFactor, IntStrategy strategy) Deprecated.
IntLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Integer> collection, IntStrategy strategy) Deprecated.
IntLinkedOpenCustomHashSet(int[] array, float loadFactor, IntStrategy strategy) Helper constructor that allow to create a set from unboxed values
IntLinkedOpenCustomHashSet(int[] array, int offset, int length, float loadFactor, IntStrategy strategy) Helper constructor that allow to create a set from unboxed values
IntLinkedOpenCustomHashSet(int[] array, int offset, int length, IntStrategy strategy) Helper constructor that allow to create a set from unboxed values
IntLinkedOpenCustomHashSet(int[] array, IntStrategy strategy) Helper constructor that allow to create a set from unboxed values
IntLinkedOpenCustomHashSet(IntCollection collection, float loadFactor, IntStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
IntLinkedOpenCustomHashSet(IntCollection collection, IntStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
IntLinkedOpenCustomHashSet(int minCapacity, float loadFactor, IntStrategy strategy) Constructor that defines the minimum capacity and load factor
IntLinkedOpenCustomHashSet(int minCapacity, IntStrategy strategy) Constructor that defines the minimum capacity
IntLinkedOpenCustomHashSet(IntIterator iterator, float loadFactor, IntStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
IntLinkedOpenCustomHashSet(IntIterator iterator, IntStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
IntLinkedOpenCustomHashSet(IntStrategy strategy) Default Contstructor
IntLinkedOpenCustomHashSet(java.util.Iterator<java.lang.Integer> iterator, float loadFactor, IntStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
IntLinkedOpenCustomHashSet(java.util.Iterator<java.lang.Integer> iterator, IntStrategy 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(int o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(int 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
IntComparator	comparator() A Type Specific Comparator method
int	firstInt() A method to get the first element in the set
IntSortedSet	headSet(int toElement) A Type Specific HeadSet method to reduce boxing/unboxing
IntListIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
IntBidirectionalIterator	iterator(int fromElement) A type Specific Iterator starting from a given key
int	lastInt() A method to get the last element in the set
boolean	moveToFirst(int o) A specific move method to move a given key to the first index.
boolean	moveToLast(int o) A specific move method to move a given key to the last index.
int	pollFirstInt() A method to get and remove the first element in the set
int	pollLastInt() A method to get and remove the last element in the set
IntSortedSet	subSet(int fromElement, int toElement) A Type Specific SubSet method to reduce boxing/unboxing
IntSortedSet	tailSet(int fromElement) A Type Specific TailSet method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.ints.sets.IntOpenCustomHashSet

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

Methods inherited from class speiger.src.collections.ints.sets.AbstractIntSet

equals, hashCode

Methods inherited from class speiger.src.collections.ints.collections.AbstractIntCollection

add, contains, containsAll, containsAny, containsAny, remInt, remove, removeAll, retainAll, toIntArray, toIntArray

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.ints.sets.IntSortedSet

first, headSet, last, spliterator, subSet, tailSet

Methods inherited from interface speiger.src.collections.ints.sets.IntSet

add, contains, remInt, remove, remove

Methods inherited from interface speiger.src.collections.ints.collections.IntCollection

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

Methods inherited from interface speiger.src.collections.ints.collections.IntIterable

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

IntLinkedOpenCustomHashSet

public IntLinkedOpenCustomHashSet(IntStrategy strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

IntLinkedOpenCustomHashSet

public IntLinkedOpenCustomHashSet(int minCapacity,
                                  IntStrategy 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

IntLinkedOpenCustomHashSet

public IntLinkedOpenCustomHashSet(int minCapacity,
                                  float loadFactor,
                                  IntStrategy 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

IntLinkedOpenCustomHashSet

public IntLinkedOpenCustomHashSet(int[] array,
                                  IntStrategy 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

IntLinkedOpenCustomHashSet

public IntLinkedOpenCustomHashSet(int[] array,
                                  float loadFactor,
                                  IntStrategy 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

IntLinkedOpenCustomHashSet

public IntLinkedOpenCustomHashSet(int[] array,
                                  int offset,
                                  int length,
                                  IntStrategy 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

IntLinkedOpenCustomHashSet

public IntLinkedOpenCustomHashSet(int[] array,
                                  int offset,
                                  int length,
                                  float loadFactor,
                                  IntStrategy 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

IntLinkedOpenCustomHashSet

@Deprecated
public IntLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Integer> collection,
                                               IntStrategy 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

IntLinkedOpenCustomHashSet

@Deprecated
public IntLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Integer> collection,
                                               float loadFactor,
                                               IntStrategy 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

IntLinkedOpenCustomHashSet

public IntLinkedOpenCustomHashSet(IntCollection collection,
                                  IntStrategy 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

IntLinkedOpenCustomHashSet

public IntLinkedOpenCustomHashSet(IntCollection collection,
                                  float loadFactor,
                                  IntStrategy 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

IntLinkedOpenCustomHashSet

public IntLinkedOpenCustomHashSet(java.util.Iterator<java.lang.Integer> iterator,
                                  IntStrategy 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

IntLinkedOpenCustomHashSet

public IntLinkedOpenCustomHashSet(java.util.Iterator<java.lang.Integer> iterator,
                                  float loadFactor,
                                  IntStrategy 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

IntLinkedOpenCustomHashSet

public IntLinkedOpenCustomHashSet(IntIterator iterator,
                                  IntStrategy 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

IntLinkedOpenCustomHashSet

public IntLinkedOpenCustomHashSet(IntIterator iterator,
                                  float loadFactor,
                                  IntStrategy 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(int o)

Description copied from interface: IntSortedSet

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

Specified by:

addAndMoveToFirst in interface IntSortedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

addAndMoveToLast

public boolean addAndMoveToLast(int o)

Description copied from interface: IntSortedSet

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

Specified by:

addAndMoveToLast in interface IntSortedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

moveToFirst

public boolean moveToFirst(int o)

Description copied from interface: IntSortedSet

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

Specified by:

moveToFirst in interface IntSortedSet

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(int o)

Description copied from interface: IntSortedSet

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

Specified by:

moveToLast in interface IntSortedSet

Parameters:

o - that should be moved to the first last

Returns:

true if the value was moved.

firstInt

public int firstInt()

Description copied from interface: IntSortedSet

A method to get the first element in the set

Specified by:

firstInt in interface IntSortedSet

Returns:

first element in the set

pollFirstInt

public int pollFirstInt()

Description copied from interface: IntSortedSet

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

Specified by:

pollFirstInt in interface IntSortedSet

Returns:

first element in the set

lastInt

public int lastInt()

Description copied from interface: IntSortedSet

A method to get the last element in the set

Specified by:

lastInt in interface IntSortedSet

Returns:

last element in the set

pollLastInt

public int pollLastInt()

Description copied from interface: IntSortedSet

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

Specified by:

pollLastInt in interface IntSortedSet

Returns:

last element in the set

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

clear in class IntOpenCustomHashSet

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 IntOpenCustomHashSet

Parameters:

size - the amount of elements that should be allowed

iterator

public IntListIterator iterator()

Description copied from interface: IntCollection

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface IntCollection

Specified by:

iterator in interface IntIterable

Specified by:

iterator in interface IntSet

Specified by:

iterator in interface IntSortedSet

Overrides:

iterator in class IntOpenCustomHashSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

public IntBidirectionalIterator iterator(int fromElement)

Description copied from interface: IntSortedSet

A type Specific Iterator starting from a given key

Specified by:

iterator in interface IntSortedSet

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

comparator

public IntComparator comparator()

Description copied from interface: IntSortedSet

A Type Specific Comparator method

Specified by:

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

Specified by:

comparator in interface IntSortedSet

Returns:

the type specific comparator

subSet

public IntSortedSet subSet(int fromElement,
                           int toElement)

Description copied from interface: IntSortedSet

A Type Specific SubSet method to reduce boxing/unboxing

Specified by:

subSet in interface IntSortedSet

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 IntSortedSet headSet(int toElement)

Description copied from interface: IntSortedSet

A Type Specific HeadSet method to reduce boxing/unboxing

Specified by:

headSet in interface IntSortedSet

Parameters:

toElement - where the HeadSet should end

Returns:

a HeadSet that is within the range of the desired range

tailSet

public IntSortedSet tailSet(int fromElement)

Description copied from interface: IntSortedSet

A Type Specific TailSet method to reduce boxing/unboxing

Specified by:

tailSet in interface IntSortedSet

Parameters:

fromElement - where the TailSet should start

Returns:

a TailSet that is within the range of the desired range