speiger.src.collections.objects.sets

Class ObjectLinkedOpenHashSet<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.ObjectOpenHashSet<T>

speiger.src.collections.objects.sets.ObjectLinkedOpenHashSet<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>, java.util.SortedSet<T>, ObjectCollection<T>, ObjectIterable<T>, ObjectSet<T>, ObjectSortedSet<T>, ITrimmable

public class ObjectLinkedOpenHashSet<T>
extends ObjectOpenHashSet<T>
implements ObjectSortedSet<T>

A Type Specific LinkedHashMap implementation that uses specific arrays to create links between nodes to remove the wrapping of elements to greatly reduce memory usage. In Addition adding some helper methods to move around elements. 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
ObjectLinkedOpenHashSet() Default Constructor
ObjectLinkedOpenHashSet(java.util.Collection<? extends T> collection) Deprecated.
ObjectLinkedOpenHashSet(java.util.Collection<? extends T> collection, float loadFactor) Deprecated.
ObjectLinkedOpenHashSet(int minCapacity) Constructor that defines the minimum capacity
ObjectLinkedOpenHashSet(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
ObjectLinkedOpenHashSet(java.util.Iterator<T> iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
ObjectLinkedOpenHashSet(java.util.Iterator<T> iterator, float loadFactor) A Helper constructor that allows to create a set from a iterator of an unknown size
ObjectLinkedOpenHashSet(ObjectCollection<T> collection) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ObjectLinkedOpenHashSet(ObjectCollection<T> collection, float loadFactor) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ObjectLinkedOpenHashSet(T[] array) Helper constructor that allow to create a set from unboxed values
ObjectLinkedOpenHashSet(T[] array, float loadFactor) Helper constructor that allow to create a set from unboxed values
ObjectLinkedOpenHashSet(T[] array, int offset, int length) Helper constructor that allow to create a set from unboxed values
ObjectLinkedOpenHashSet(T[] array, int offset, int length, float loadFactor) Helper constructor that allow to create a set from unboxed values

Method Summary

Modifier and Type	Method and Description
boolean	addAndMoveToFirst(T o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(T 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
java.util.Comparator<T>	comparator() A Type Specific Comparator method
T	first()
ObjectSortedSet<T>	headSet(T toElement)
ObjectListIterator<T>	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
ObjectBidirectionalIterator<T>	iterator(T fromElement) A type Specific Iterator starting from a given key
T	last()
boolean	moveToFirst(T o) A specific move method to move a given key to the first index.
boolean	moveToLast(T o) A specific move method to move a given key to the last index.
T	pollFirst() A method to get and remove the first element in the set
T	pollLast() A method to get and remove the last element in the set
ObjectSortedSet<T>	subSet(T fromElement, T toElement)
ObjectSortedSet<T>	tailSet(T fromElement)

Methods inherited from class speiger.src.collections.objects.sets.ObjectOpenHashSet

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

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

spliterator

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

addAll, containsAll, containsAny, containsAny, removeAll, retainAll

Methods inherited from interface java.util.Set

add, addAll, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

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

clearAndTrim, trim

Constructor Detail

ObjectLinkedOpenHashSet

public ObjectLinkedOpenHashSet()

Default Constructor

ObjectLinkedOpenHashSet

public ObjectLinkedOpenHashSet(int minCapacity)

Constructor that defines the minimum capacity

Parameters:

minCapacity - the minimum capacity the HashSet is allowed to be.

Throws:

java.lang.IllegalStateException - if the minimum capacity is negative

ObjectLinkedOpenHashSet

public ObjectLinkedOpenHashSet(int minCapacity,
                               float loadFactor)

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

Throws:

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

ObjectLinkedOpenHashSet

public ObjectLinkedOpenHashSet(T[] array)

Helper constructor that allow to create a set from unboxed values

Parameters:

array - the elements that should be put into the set

ObjectLinkedOpenHashSet

public ObjectLinkedOpenHashSet(T[] array,
                               float loadFactor)

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

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

ObjectLinkedOpenHashSet

public ObjectLinkedOpenHashSet(T[] array,
                               int offset,
                               int length)

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

Throws:

java.lang.IllegalStateException - if offset and length causes to step outside of the arrays range

ObjectLinkedOpenHashSet

public ObjectLinkedOpenHashSet(T[] array,
                               int offset,
                               int length,
                               float loadFactor)

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

Throws:

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

ObjectLinkedOpenHashSet

@Deprecated
public ObjectLinkedOpenHashSet(java.util.Collection<? extends T> collection)

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

ObjectLinkedOpenHashSet

@Deprecated
public ObjectLinkedOpenHashSet(java.util.Collection<? extends T> collection,
                                            float loadFactor)

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

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

ObjectLinkedOpenHashSet

public ObjectLinkedOpenHashSet(ObjectCollection<T> collection)

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

ObjectLinkedOpenHashSet

public ObjectLinkedOpenHashSet(ObjectCollection<T> collection,
                               float loadFactor)

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

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

ObjectLinkedOpenHashSet

public ObjectLinkedOpenHashSet(java.util.Iterator<T> iterator)

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

ObjectLinkedOpenHashSet

public ObjectLinkedOpenHashSet(java.util.Iterator<T> iterator,
                               float loadFactor)

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

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Method Detail

addAndMoveToFirst

public boolean addAndMoveToFirst(T o)

Description copied from interface: ObjectSortedSet

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

Specified by:

addAndMoveToFirst in interface ObjectSortedSet<T>

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

addAndMoveToLast

public boolean addAndMoveToLast(T o)

Description copied from interface: ObjectSortedSet

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

Specified by:

addAndMoveToLast in interface ObjectSortedSet<T>

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

moveToFirst

public boolean moveToFirst(T o)

Description copied from interface: ObjectSortedSet

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

Specified by:

moveToFirst in interface ObjectSortedSet<T>

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(T o)

Description copied from interface: ObjectSortedSet

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

Specified by:

moveToLast in interface ObjectSortedSet<T>

Parameters:

o - that should be moved to the first last

Returns:

true if the value was moved.

first

public T first()

Specified by:

first in interface java.util.SortedSet<T>

pollFirst

public T pollFirst()

Description copied from interface: ObjectSortedSet

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

Specified by:

pollFirst in interface ObjectSortedSet<T>

Returns:

first element in the set

last

public T last()

Specified by:

last in interface java.util.SortedSet<T>

pollLast

public T pollLast()

Description copied from interface: ObjectSortedSet

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

Specified by:

pollLast in interface ObjectSortedSet<T>

Returns:

last element in the set

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 ObjectOpenHashSet<T>

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 ObjectOpenHashSet<T>

Parameters:

size - the amount of elements that should be allowed

iterator

public ObjectListIterator<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 interface ObjectSortedSet<T>

Overrides:

iterator in class ObjectOpenHashSet<T>

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

public ObjectBidirectionalIterator<T> iterator(T fromElement)

Description copied from interface: ObjectSortedSet

A type Specific Iterator starting from a given key

Specified by:

iterator in interface ObjectSortedSet<T>

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

comparator

public java.util.Comparator<T> comparator()

Description copied from interface: ObjectSortedSet

A Type Specific Comparator method

Specified by:

comparator in interface java.util.SortedSet<T>

Specified by:

comparator in interface ObjectSortedSet<T>

Returns:

the type specific comparator

subSet

public ObjectSortedSet<T> subSet(T fromElement,
                                 T toElement)

Specified by:

subSet in interface java.util.SortedSet<T>

Specified by:

subSet in interface ObjectSortedSet<T>

headSet

public ObjectSortedSet<T> headSet(T toElement)

Specified by:

headSet in interface java.util.SortedSet<T>

Specified by:

headSet in interface ObjectSortedSet<T>

tailSet

public ObjectSortedSet<T> tailSet(T fromElement)

Specified by:

tailSet in interface java.util.SortedSet<T>

Specified by:

tailSet in interface ObjectSortedSet<T>