speiger.src.collections.longs.sets

Class LongLinkedOpenCustomHashSet

java.lang.Object

java.util.AbstractCollection<java.lang.Long>

speiger.src.collections.longs.collections.AbstractLongCollection

speiger.src.collections.longs.sets.AbstractLongSet

speiger.src.collections.longs.sets.LongOpenCustomHashSet

speiger.src.collections.longs.sets.LongLinkedOpenCustomHashSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Long>, java.util.Collection<java.lang.Long>, java.util.Set<java.lang.Long>, java.util.SortedSet<java.lang.Long>, LongCollection, LongIterable, LongSet, LongSortedSet, ITrimmable

public class LongLinkedOpenCustomHashSet
extends LongOpenCustomHashSet
implements LongSortedSet

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
LongLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Long> collection, float loadFactor, LongStrategy strategy) Deprecated.
LongLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Long> collection, LongStrategy strategy) Deprecated.
LongLinkedOpenCustomHashSet(int minCapacity, float loadFactor, LongStrategy strategy) Constructor that defines the minimum capacity and load factor
LongLinkedOpenCustomHashSet(int minCapacity, LongStrategy strategy) Constructor that defines the minimum capacity
LongLinkedOpenCustomHashSet(java.util.Iterator<java.lang.Long> iterator, float loadFactor, LongStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
LongLinkedOpenCustomHashSet(java.util.Iterator<java.lang.Long> iterator, LongStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
LongLinkedOpenCustomHashSet(long[] array, float loadFactor, LongStrategy strategy) Helper constructor that allow to create a set from unboxed values
LongLinkedOpenCustomHashSet(long[] array, int offset, int length, float loadFactor, LongStrategy strategy) Helper constructor that allow to create a set from unboxed values
LongLinkedOpenCustomHashSet(long[] array, int offset, int length, LongStrategy strategy) Helper constructor that allow to create a set from unboxed values
LongLinkedOpenCustomHashSet(long[] array, LongStrategy strategy) Helper constructor that allow to create a set from unboxed values
LongLinkedOpenCustomHashSet(LongCollection collection, float loadFactor, LongStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
LongLinkedOpenCustomHashSet(LongCollection collection, LongStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
LongLinkedOpenCustomHashSet(LongIterator iterator, float loadFactor, LongStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
LongLinkedOpenCustomHashSet(LongIterator iterator, LongStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
LongLinkedOpenCustomHashSet(LongStrategy strategy) Default Contstructor

Method Summary

Modifier and Type	Method and Description
boolean	addAndMoveToFirst(long o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(long 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
LongComparator	comparator() A Type Specific Comparator method
long	firstLong() A method to get the first element in the set
LongSortedSet	headSet(long toElement) A Type Specific HeadSet method to reduce boxing/unboxing
LongListIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
LongBidirectionalIterator	iterator(long fromElement) A type Specific Iterator starting from a given key
long	lastLong() A method to get the last element in the set
boolean	moveToFirst(long o) A specific move method to move a given key to the first index.
boolean	moveToLast(long o) A specific move method to move a given key to the last index.
long	pollFirstLong() A method to get and remove the first element in the set
long	pollLastLong() A method to get and remove the last element in the set
LongSortedSet	subSet(long fromElement, long toElement) A Type Specific SubSet method to reduce boxing/unboxing
LongSortedSet	tailSet(long fromElement) A Type Specific TailSet method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.longs.sets.LongOpenCustomHashSet

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

Methods inherited from class speiger.src.collections.longs.sets.AbstractLongSet

equals, hashCode

Methods inherited from class speiger.src.collections.longs.collections.AbstractLongCollection

add, contains, containsAll, containsAny, containsAny, remLong, remove, removeAll, retainAll, toLongArray, toLongArray

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.longs.sets.LongSortedSet

first, headSet, last, spliterator, subSet, tailSet

Methods inherited from interface speiger.src.collections.longs.sets.LongSet

add, contains, remLong, remove, remove

Methods inherited from interface speiger.src.collections.longs.collections.LongCollection

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

Methods inherited from interface speiger.src.collections.longs.collections.LongIterable

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

LongLinkedOpenCustomHashSet

public LongLinkedOpenCustomHashSet(LongStrategy strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

LongLinkedOpenCustomHashSet

public LongLinkedOpenCustomHashSet(int minCapacity,
                                   LongStrategy 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

LongLinkedOpenCustomHashSet

public LongLinkedOpenCustomHashSet(int minCapacity,
                                   float loadFactor,
                                   LongStrategy 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

LongLinkedOpenCustomHashSet

public LongLinkedOpenCustomHashSet(long[] array,
                                   LongStrategy 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

LongLinkedOpenCustomHashSet

public LongLinkedOpenCustomHashSet(long[] array,
                                   float loadFactor,
                                   LongStrategy 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

LongLinkedOpenCustomHashSet

public LongLinkedOpenCustomHashSet(long[] array,
                                   int offset,
                                   int length,
                                   LongStrategy 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

LongLinkedOpenCustomHashSet

public LongLinkedOpenCustomHashSet(long[] array,
                                   int offset,
                                   int length,
                                   float loadFactor,
                                   LongStrategy 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

LongLinkedOpenCustomHashSet

@Deprecated
public LongLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Long> collection,
                                                LongStrategy 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

LongLinkedOpenCustomHashSet

@Deprecated
public LongLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Long> collection,
                                                float loadFactor,
                                                LongStrategy 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

LongLinkedOpenCustomHashSet

public LongLinkedOpenCustomHashSet(LongCollection collection,
                                   LongStrategy 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

LongLinkedOpenCustomHashSet

public LongLinkedOpenCustomHashSet(LongCollection collection,
                                   float loadFactor,
                                   LongStrategy 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

LongLinkedOpenCustomHashSet

public LongLinkedOpenCustomHashSet(java.util.Iterator<java.lang.Long> iterator,
                                   LongStrategy 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

LongLinkedOpenCustomHashSet

public LongLinkedOpenCustomHashSet(java.util.Iterator<java.lang.Long> iterator,
                                   float loadFactor,
                                   LongStrategy 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

LongLinkedOpenCustomHashSet

public LongLinkedOpenCustomHashSet(LongIterator iterator,
                                   LongStrategy 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

LongLinkedOpenCustomHashSet

public LongLinkedOpenCustomHashSet(LongIterator iterator,
                                   float loadFactor,
                                   LongStrategy 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(long o)

Description copied from interface: LongSortedSet

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

Specified by:

addAndMoveToFirst in interface LongSortedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

addAndMoveToLast

public boolean addAndMoveToLast(long o)

Description copied from interface: LongSortedSet

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

Specified by:

addAndMoveToLast in interface LongSortedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

moveToFirst

public boolean moveToFirst(long o)

Description copied from interface: LongSortedSet

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

Specified by:

moveToFirst in interface LongSortedSet

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(long o)

Description copied from interface: LongSortedSet

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

Specified by:

moveToLast in interface LongSortedSet

Parameters:

o - that should be moved to the first last

Returns:

true if the value was moved.

firstLong

public long firstLong()

Description copied from interface: LongSortedSet

A method to get the first element in the set

Specified by:

firstLong in interface LongSortedSet

Returns:

first element in the set

pollFirstLong

public long pollFirstLong()

Description copied from interface: LongSortedSet

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

Specified by:

pollFirstLong in interface LongSortedSet

Returns:

first element in the set

lastLong

public long lastLong()

Description copied from interface: LongSortedSet

A method to get the last element in the set

Specified by:

lastLong in interface LongSortedSet

Returns:

last element in the set

pollLastLong

public long pollLastLong()

Description copied from interface: LongSortedSet

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

Specified by:

pollLastLong in interface LongSortedSet

Returns:

last element in the set

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

clear in class LongOpenCustomHashSet

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 LongOpenCustomHashSet

Parameters:

size - the amount of elements that should be allowed

iterator

public LongListIterator iterator()

Description copied from interface: LongCollection

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface LongCollection

Specified by:

iterator in interface LongIterable

Specified by:

iterator in interface LongSet

Specified by:

iterator in interface LongSortedSet

Overrides:

iterator in class LongOpenCustomHashSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

public LongBidirectionalIterator iterator(long fromElement)

Description copied from interface: LongSortedSet

A type Specific Iterator starting from a given key

Specified by:

iterator in interface LongSortedSet

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

comparator

public LongComparator comparator()

Description copied from interface: LongSortedSet

A Type Specific Comparator method

Specified by:

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

Specified by:

comparator in interface LongSortedSet

Returns:

the type specific comparator

subSet

public LongSortedSet subSet(long fromElement,
                            long toElement)

Description copied from interface: LongSortedSet

A Type Specific SubSet method to reduce boxing/unboxing

Specified by:

subSet in interface LongSortedSet

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 LongSortedSet headSet(long toElement)

Description copied from interface: LongSortedSet

A Type Specific HeadSet method to reduce boxing/unboxing

Specified by:

headSet in interface LongSortedSet

Parameters:

toElement - where the HeadSet should end

Returns:

a HeadSet that is within the range of the desired range

tailSet

public LongSortedSet tailSet(long fromElement)

Description copied from interface: LongSortedSet

A Type Specific TailSet method to reduce boxing/unboxing

Specified by:

tailSet in interface LongSortedSet

Parameters:

fromElement - where the TailSet should start

Returns:

a TailSet that is within the range of the desired range