ImmutableLongOpenHashSet (Primitive-Collections 0.7.0 API)

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.ImmutableLongOpenHashSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Long>, java.util.Collection<java.lang.Long>, java.util.Set<java.lang.Long>, LongCollection, LongIterable, LongOrderedSet, LongSet
```
public class ImmutableLongOpenHashSet
extends AbstractLongSet
implements LongOrderedSet
```
A Type Specific Custom implementation of the HashSet Instead of using Wrapper Object Arrays for storing keys and values there is dedicated arrays for storing keys. Extra to that there is a couple quality of life functions provided

Constructor Summary

Constructors
Constructor and Description
`ImmutableLongOpenHashSet(java.util.Collection<? extends java.lang.Long> collection)` Deprecated.
`ImmutableLongOpenHashSet(java.util.Collection<? extends java.lang.Long> collection, float loadFactor)` Deprecated.
`ImmutableLongOpenHashSet(java.util.Iterator<java.lang.Long> iterator)` A Helper constructor that allows to create a set from a iterator of an unknown size
`ImmutableLongOpenHashSet(java.util.Iterator<java.lang.Long> iterator, float loadFactor)` A Helper constructor that allows to create a set from a iterator of an unknown size
`ImmutableLongOpenHashSet(long[] array)` Helper constructor that allow to create a set from unboxed values
`ImmutableLongOpenHashSet(long[] array, float loadFactor)` Helper constructor that allow to create a set from unboxed values
`ImmutableLongOpenHashSet(long[] array, int offset, int length)` Helper constructor that allow to create a set from unboxed values
`ImmutableLongOpenHashSet(long[] array, int offset, int length, float loadFactor)` Helper constructor that allow to create a set from unboxed values
`ImmutableLongOpenHashSet(LongCollection collection)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`ImmutableLongOpenHashSet(LongCollection collection, float loadFactor)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`ImmutableLongOpenHashSet(LongIterator iterator)` A Helper constructor that allows to create a set from a iterator of an unknown size
`ImmutableLongOpenHashSet(LongIterator iterator, float loadFactor)` A Helper constructor that allows to create a set from a iterator of an unknown size

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(long o)` A Type-Specific add function to reduce (un)boxing
`boolean`	`addAll(java.util.Collection<? extends java.lang.Long> c)` Deprecated.
`boolean`	`addAll(LongCollection c)` A Type-Specific addAll function to reduce (un)boxing
`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()`
`boolean`	`contains(long o)` A Type-Specific implementation of contains.
`boolean`	`contains(java.lang.Object o)` This default implementation delegates to the corresponding type-specific function.
`ImmutableLongOpenHashSet`	`copy()` A Function that does a shallow clone of the Collection itself.
`int`	`count(Long2BooleanFunction filter)` Helper function to reduce stream usage that allows to count the valid elements.
`long`	`findFirst(Long2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for the first match.
`long`	`firstLong()` A method to get the first element in the set
`<E> void`	`forEach(E input, ObjectLongConsumer<E> action)` Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
`void`	`forEach(LongConsumer action)` A Type Specific foreach function that reduces (un)boxing
`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`	`matchesAll(Long2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for all matches.
`boolean`	`matchesAny(Long2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for any matches.
`boolean`	`matchesNone(Long2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for no matches.
`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
`long`	`reduce(long identity, LongLongUnaryOperator operator)` Performs a reduction on the elements of this Iterable
`long`	`reduce(LongLongUnaryOperator operator)` Performs a reduction on the elements of this Iterable
`boolean`	`remove(long o)` A Type Specific remove function to reduce boxing/unboxing
`boolean`	`remove(java.lang.Object o)` This default implementation delegates to the corresponding type-specific function.
`int`	`size()`

Methods inherited from class speiger.src.collections.longs.sets.AbstractLongSet
equals, hashCode

Methods inherited from class speiger.src.collections.longs.collections.AbstractLongCollection
add, containsAll, containsAll, containsAny, containsAny, remLong, removeAll, removeAll, retainAll, retainAll, toLongArray, toLongArray

Methods inherited from class java.util.AbstractCollection
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.LongOrderedSet
spliterator, synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.longs.sets.LongSet
add, remLong

Methods inherited from interface java.util.Set
containsAll, equals, hashCode, isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from interface speiger.src.collections.longs.collections.LongCollection
addAll, addAll, addAll, containsAll, containsAny, containsAny, parallelPrimitiveStream, pour, primitiveStream, remIf, removeAll, removeAll, removeIf, retainAll, retainAll, toLongArray, toLongArray

Methods inherited from interface java.util.Collection
parallelStream, stream

Methods inherited from interface speiger.src.collections.longs.collections.LongIterable
arrayflatMap, asAsync, distinct, filter, flatMap, forEach, limit, map, peek, pourAsList, pourAsSet, sorted

- Constructor Detail
  - ImmutableLongOpenHashSet
```
public ImmutableLongOpenHashSet(long[] array)
```
    Helper constructor that allow to create a set from unboxed values
    
    Parameters:
    
    array - the elements that should be put into the set
  - ImmutableLongOpenHashSet
```
public ImmutableLongOpenHashSet(long[] 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
  - ImmutableLongOpenHashSet
```
public ImmutableLongOpenHashSet(long[] 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
  - ImmutableLongOpenHashSet
```
public ImmutableLongOpenHashSet(long[] 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
  - ImmutableLongOpenHashSet
```
@Deprecated
public ImmutableLongOpenHashSet(java.util.Collection<? extends java.lang.Long> 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
  - ImmutableLongOpenHashSet
```
@Deprecated
public ImmutableLongOpenHashSet(java.util.Collection<? extends java.lang.Long> 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
  - ImmutableLongOpenHashSet
```
public ImmutableLongOpenHashSet(LongCollection 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
  - ImmutableLongOpenHashSet
```
public ImmutableLongOpenHashSet(LongCollection 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
  - ImmutableLongOpenHashSet
```
public ImmutableLongOpenHashSet(java.util.Iterator<java.lang.Long> 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
  - ImmutableLongOpenHashSet
```
public ImmutableLongOpenHashSet(java.util.Iterator<java.lang.Long> 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
  - ImmutableLongOpenHashSet
```
public ImmutableLongOpenHashSet(LongIterator 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
  - ImmutableLongOpenHashSet
```
public ImmutableLongOpenHashSet(LongIterator 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
  - add
```
public boolean add(long o)
```
    Description copied from interface: LongCollection
    
    A Type-Specific add function to reduce (un)boxing
    
    Specified by:
    
    add in interface LongCollection
    
    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.Long> c)
```
    Deprecated.
    
    Description copied from class: AbstractLongCollection
    
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    addAll in interface java.util.Collection<java.lang.Long>
    
    Specified by:
    
    addAll in interface java.util.Set<java.lang.Long>
    
    Overrides:
    
    addAll in class AbstractLongCollection
  - addAll
```
public boolean addAll(LongCollection c)
```
    Description copied from interface: LongCollection
    
    A Type-Specific addAll function to reduce (un)boxing
    
    Specified by:
    
    addAll in interface LongCollection
    
    Overrides:
    
    addAll in class AbstractLongCollection
    
    Parameters:
    
    c - the collection of elements that should be added
    
    Returns:
    
    true if elements were added into the collection
  - addAndMoveToFirst
```
public boolean addAndMoveToFirst(long o)
```
    Description copied from interface: LongOrderedSet
    
    A customized add method that allows you to insert into the first index.
    
    Specified by:
    
    addAndMoveToFirst in interface LongOrderedSet
    
    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: LongOrderedSet
    
    A customized add method that allows you to insert into the last index.
    
    Specified by:
    
    addAndMoveToLast in interface LongOrderedSet
    
    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: LongOrderedSet
    
    A specific move method to move a given key to the first index.
    
    Specified by:
    
    moveToFirst in interface LongOrderedSet
    
    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: LongOrderedSet
    
    A specific move method to move a given key to the last index.
    
    Specified by:
    
    moveToLast in interface LongOrderedSet
    
    Parameters:
    
    o - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - contains
```
public boolean contains(java.lang.Object o)
```
    Description copied from class: AbstractLongCollection
    
    This default implementation delegates to the corresponding type-specific function.
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    contains in interface java.util.Collection<java.lang.Long>
    
    Specified by:
    
    contains in interface java.util.Set<java.lang.Long>
    
    Specified by:
    
    contains in interface LongCollection
    
    Specified by:
    
    contains in interface LongSet
    
    Overrides:
    
    contains in class AbstractLongCollection
  - firstLong
```
public long firstLong()
```
    Description copied from interface: LongOrderedSet
    
    A method to get the first element in the set
    
    Specified by:
    
    firstLong in interface LongOrderedSet
    
    Returns:
    
    first element in the set
  - pollFirstLong
```
public long pollFirstLong()
```
    Description copied from interface: LongOrderedSet
    
    A method to get and remove the first element in the set
    
    Specified by:
    
    pollFirstLong in interface LongOrderedSet
    
    Returns:
    
    first element in the set
  - lastLong
```
public long lastLong()
```
    Description copied from interface: LongOrderedSet
    
    A method to get the last element in the set
    
    Specified by:
    
    lastLong in interface LongOrderedSet
    
    Returns:
    
    last element in the set
  - pollLastLong
```
public long pollLastLong()
```
    Description copied from interface: LongOrderedSet
    
    A method to get and remove the last element in the set
    
    Specified by:
    
    pollLastLong in interface LongOrderedSet
    
    Returns:
    
    last element in the set
  - remove
```
public boolean remove(java.lang.Object o)
```
    Description copied from class: AbstractLongCollection
    
    This default implementation delegates to the corresponding type-specific function.
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    remove in interface java.util.Collection<java.lang.Long>
    
    Specified by:
    
    remove in interface java.util.Set<java.lang.Long>
    
    Specified by:
    
    remove in interface LongCollection
    
    Specified by:
    
    remove in interface LongSet
    
    Overrides:
    
    remove in class AbstractLongCollection
  - contains
```
public boolean contains(long o)
```
    Description copied from class: AbstractLongCollection
    
    A Type-Specific implementation of contains. This implementation iterates over the elements and returns true if the value match.
    
    Specified by:
    
    contains in interface LongCollection
    
    Overrides:
    
    contains in class AbstractLongCollection
    
    Parameters:
    
    o - the element that should be searched for.
    
    Returns:
    
    true if the value was found.
  - remove
```
public boolean remove(long o)
```
    Description copied from interface: LongSet
    
    A Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface LongSet
    
    Parameters:
    
    o - the element that should be removed
    
    Returns:
    
    true if the element was removed
  - forEach
```
public void forEach(LongConsumer action)
```
    Description copied from interface: LongIterable
    
    A Type Specific foreach function that reduces (un)boxing
    
    Specified by:
    
    forEach in interface LongIterable
    
    Parameters:
    
    action - The action to be performed for each element
    
    See Also:
    
    Iterable.forEach(Consumer)
  - forEach
```
public <E> void forEach(E input,
                        ObjectLongConsumer<E> action)
```
    Description copied from interface: LongIterable
    
    Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
    
    Specified by:
    
    forEach in interface LongIterable
    
    Type Parameters:
    
    E - the generic type of the Object
    
    Parameters:
    
    input - the object that should be included
    
    action - The action to be performed for each element
  - matchesAny
```
public boolean matchesAny(Long2BooleanFunction filter)
```
    Description copied from interface: LongIterable
    
    Helper function to reduce stream usage that allows to filter for any matches.
    
    Specified by:
    
    matchesAny in interface LongIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if any matches were found
  - matchesNone
```
public boolean matchesNone(Long2BooleanFunction filter)
```
    Description copied from interface: LongIterable
    
    Helper function to reduce stream usage that allows to filter for no matches.
    
    Specified by:
    
    matchesNone in interface LongIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if no matches were found
  - matchesAll
```
public boolean matchesAll(Long2BooleanFunction filter)
```
    Description copied from interface: LongIterable
    
    Helper function to reduce stream usage that allows to filter for all matches.
    
    Specified by:
    
    matchesAll in interface LongIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if all matches.
  - reduce
```
public long reduce(long identity,
                   LongLongUnaryOperator operator)
```
    Description copied from interface: LongIterable
    
    Performs a reduction on the elements of this Iterable
    
    Specified by:
    
    reduce in interface LongIterable
    
    Parameters:
    
    identity - the start value
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns identity if nothing was found
  - reduce
```
public long reduce(LongLongUnaryOperator operator)
```
    Description copied from interface: LongIterable
    
    Performs a reduction on the elements of this Iterable
    
    Specified by:
    
    reduce in interface LongIterable
    
    Parameters:
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns null value if nothing was found
  - findFirst
```
public long findFirst(Long2BooleanFunction filter)
```
    Description copied from interface: LongIterable
    
    Helper function to reduce stream usage that allows to filter for the first match.
    
    Specified by:
    
    findFirst in interface LongIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the found value or the null equivalent variant.
  - count
```
public int count(Long2BooleanFunction filter)
```
    Description copied from interface: LongIterable
    
    Helper function to reduce stream usage that allows to count the valid elements.
    
    Specified by:
    
    count in interface LongIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the amount of Valid Elements
  - 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 LongOrderedSet
    
    Specified by:
    
    iterator in interface LongSet
    
    Specified by:
    
    iterator in class AbstractLongSet
    
    Returns:
    
    a iterator of the collection
    
    See Also:
    
    Collection.iterator()
  - iterator
```
public LongBidirectionalIterator iterator(long fromElement)
```
    Description copied from interface: LongOrderedSet
    
    A type Specific Iterator starting from a given key
    
    Specified by:
    
    iterator in interface LongOrderedSet
    
    Parameters:
    
    fromElement - the element the iterator should start from
    
    Returns:
    
    a iterator starting from the given element
  - copy
```
public ImmutableLongOpenHashSet copy()
```
    Description copied from interface: LongCollection
    
    A Function that does a shallow clone of the Collection itself. This function is more optimized then a copy constructor since the Collection does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk
    
    Specified by:
    
    copy in interface LongCollection
    
    Specified by:
    
    copy in interface LongOrderedSet
    
    Specified by:
    
    copy in interface LongSet
    
    Overrides:
    
    copy in class AbstractLongSet
    
    Returns:
    
    a Shallow Copy of the collection
  - 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 java.util.AbstractCollection<java.lang.Long>
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection<java.lang.Long>
    
    Specified by:
    
    size in interface java.util.Set<java.lang.Long>
    
    Specified by:
    
    size in class java.util.AbstractCollection<java.lang.Long>

Class ImmutableLongOpenHashSet

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface java.util.Set

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

Methods inherited from interface java.util.Collection

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

Constructor Detail

ImmutableLongOpenHashSet

ImmutableLongOpenHashSet

ImmutableLongOpenHashSet

ImmutableLongOpenHashSet

ImmutableLongOpenHashSet

ImmutableLongOpenHashSet

ImmutableLongOpenHashSet

ImmutableLongOpenHashSet

ImmutableLongOpenHashSet

ImmutableLongOpenHashSet

ImmutableLongOpenHashSet

ImmutableLongOpenHashSet

Method Detail

add

addAll

addAll

addAndMoveToFirst

addAndMoveToLast

moveToFirst

moveToLast

contains

firstLong

pollFirstLong

lastLong

pollLastLong

remove

contains

remove

forEach

forEach

matchesAny

matchesNone

matchesAll

reduce

reduce

findFirst

count

iterator

iterator

copy

clear

size