ImmutableByteOpenHashSet (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractCollection<java.lang.Byte>
- - speiger.src.collections.bytes.collections.AbstractByteCollection
  - - speiger.src.collections.bytes.sets.AbstractByteSet
    - - speiger.src.collections.bytes.sets.ImmutableByteOpenHashSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Byte>, java.util.Collection<java.lang.Byte>, java.util.Set<java.lang.Byte>, ByteCollection, ByteIterable, ByteOrderedSet, ByteSet
```
public class ImmutableByteOpenHashSet
extends AbstractByteSet
implements ByteOrderedSet
```
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
`ImmutableByteOpenHashSet(byte[] array)` Helper constructor that allow to create a set from unboxed values
`ImmutableByteOpenHashSet(byte[] array, float loadFactor)` Helper constructor that allow to create a set from unboxed values
`ImmutableByteOpenHashSet(byte[] array, int offset, int length)` Helper constructor that allow to create a set from unboxed values
`ImmutableByteOpenHashSet(byte[] array, int offset, int length, float loadFactor)` Helper constructor that allow to create a set from unboxed values
`ImmutableByteOpenHashSet(ByteCollection collection)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`ImmutableByteOpenHashSet(ByteCollection collection, float loadFactor)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`ImmutableByteOpenHashSet(ByteIterator iterator)` A Helper constructor that allows to create a set from a iterator of an unknown size
`ImmutableByteOpenHashSet(ByteIterator iterator, float loadFactor)` A Helper constructor that allows to create a set from a iterator of an unknown size
`ImmutableByteOpenHashSet(java.util.Collection<? extends java.lang.Byte> collection)` Deprecated.
`ImmutableByteOpenHashSet(java.util.Collection<? extends java.lang.Byte> collection, float loadFactor)` Deprecated.
`ImmutableByteOpenHashSet(java.util.Iterator<java.lang.Byte> iterator)` A Helper constructor that allows to create a set from a iterator of an unknown size
`ImmutableByteOpenHashSet(java.util.Iterator<java.lang.Byte> 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(byte o)` A Type-Specific add function to reduce (un)boxing
`boolean`	`addAll(ByteCollection c)` A Type-Specific addAll function to reduce (un)boxing
`boolean`	`addAll(java.util.Collection<? extends java.lang.Byte> c)` Deprecated.
`boolean`	`addAndMoveToFirst(byte o)` A customized add method that allows you to insert into the first index.
`boolean`	`addAndMoveToLast(byte o)` A customized add method that allows you to insert into the last index.
`void`	`clear()`
`boolean`	`contains(byte o)` A Type-Specific implementation of contains.
`boolean`	`contains(java.lang.Object o)` This default implementation delegates to the corresponding type-specific function.
`ImmutableByteOpenHashSet`	`copy()` A Function that does a shallow clone of the Collection itself.
`int`	`count(Byte2BooleanFunction filter)` Helper function to reduce stream usage that allows to count the valid elements.
`byte`	`findFirst(Byte2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for the first match.
`byte`	`firstByte()` A method to get the first element in the set
`void`	`forEach(ByteConsumer action)` A Type Specific foreach function that reduces (un)boxing
`<E> void`	`forEach(E input, ObjectByteConsumer<E> action)` Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
`ByteListIterator`	`iterator()` Returns a Type-Specific Iterator to reduce (un)boxing
`ByteBidirectionalIterator`	`iterator(byte fromElement)` A type Specific Iterator starting from a given key
`byte`	`lastByte()` A method to get the last element in the set
`boolean`	`matchesAll(Byte2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for all matches.
`boolean`	`matchesAny(Byte2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for any matches.
`boolean`	`matchesNone(Byte2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for no matches.
`boolean`	`moveToFirst(byte o)` A specific move method to move a given key to the first index.
`boolean`	`moveToLast(byte o)` A specific move method to move a given key to the last index.
`byte`	`pollFirstByte()` A method to get and remove the first element in the set
`byte`	`pollLastByte()` A method to get and remove the last element in the set
`byte`	`reduce(byte identity, ByteByteUnaryOperator operator)` Performs a reduction on the elements of this Iterable
`byte`	`reduce(ByteByteUnaryOperator operator)` Performs a reduction on the elements of this Iterable
`boolean`	`remove(byte 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.bytes.sets.AbstractByteSet
equals, hashCode

Methods inherited from class speiger.src.collections.bytes.collections.AbstractByteCollection
add, containsAll, containsAll, containsAny, containsAny, remByte, removeAll, removeAll, retainAll, retainAll, toByteArray, toByteArray

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.bytes.sets.ByteOrderedSet
spliterator, synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.bytes.sets.ByteSet
add, remByte

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

Methods inherited from interface speiger.src.collections.bytes.collections.ByteCollection
addAll, addAll, addAll, containsAll, containsAny, containsAny, parallelPrimitiveStream, pour, primitiveStream, remIf, removeAll, removeAll, removeIf, retainAll, retainAll, toByteArray, toByteArray

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

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

- Constructor Detail
  - ImmutableByteOpenHashSet
```
public ImmutableByteOpenHashSet(byte[] array)
```
    Helper constructor that allow to create a set from unboxed values
    
    Parameters:
    
    array - the elements that should be put into the set
  - ImmutableByteOpenHashSet
```
public ImmutableByteOpenHashSet(byte[] 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
  - ImmutableByteOpenHashSet
```
public ImmutableByteOpenHashSet(byte[] 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
  - ImmutableByteOpenHashSet
```
public ImmutableByteOpenHashSet(byte[] 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
  - ImmutableByteOpenHashSet
```
@Deprecated
public ImmutableByteOpenHashSet(java.util.Collection<? extends java.lang.Byte> 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
  - ImmutableByteOpenHashSet
```
@Deprecated
public ImmutableByteOpenHashSet(java.util.Collection<? extends java.lang.Byte> 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
  - ImmutableByteOpenHashSet
```
public ImmutableByteOpenHashSet(ByteCollection 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
  - ImmutableByteOpenHashSet
```
public ImmutableByteOpenHashSet(ByteCollection 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
  - ImmutableByteOpenHashSet
```
public ImmutableByteOpenHashSet(java.util.Iterator<java.lang.Byte> 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
  - ImmutableByteOpenHashSet
```
public ImmutableByteOpenHashSet(java.util.Iterator<java.lang.Byte> 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
  - ImmutableByteOpenHashSet
```
public ImmutableByteOpenHashSet(ByteIterator 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
  - ImmutableByteOpenHashSet
```
public ImmutableByteOpenHashSet(ByteIterator 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(byte o)
```
    Description copied from interface: ByteCollection
    
    A Type-Specific add function to reduce (un)boxing
    
    Specified by:
    
    add in interface ByteCollection
    
    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.Byte> c)
```
    Deprecated.
    
    Description copied from class: AbstractByteCollection
    
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    addAll in interface java.util.Collection<java.lang.Byte>
    
    Specified by:
    
    addAll in interface java.util.Set<java.lang.Byte>
    
    Overrides:
    
    addAll in class AbstractByteCollection
  - addAll
```
public boolean addAll(ByteCollection c)
```
    Description copied from interface: ByteCollection
    
    A Type-Specific addAll function to reduce (un)boxing
    
    Specified by:
    
    addAll in interface ByteCollection
    
    Overrides:
    
    addAll in class AbstractByteCollection
    
    Parameters:
    
    c - the collection of elements that should be added
    
    Returns:
    
    true if elements were added into the collection
  - addAndMoveToFirst
```
public boolean addAndMoveToFirst(byte o)
```
    Description copied from interface: ByteOrderedSet
    
    A customized add method that allows you to insert into the first index.
    
    Specified by:
    
    addAndMoveToFirst in interface ByteOrderedSet
    
    Parameters:
    
    o - the element that should be inserted
    
    Returns:
    
    true if it was added
    
    See Also:
    
    Set.add(Object)
  - addAndMoveToLast
```
public boolean addAndMoveToLast(byte o)
```
    Description copied from interface: ByteOrderedSet
    
    A customized add method that allows you to insert into the last index.
    
    Specified by:
    
    addAndMoveToLast in interface ByteOrderedSet
    
    Parameters:
    
    o - the element that should be inserted
    
    Returns:
    
    true if it was added
    
    See Also:
    
    Set.add(Object)
  - moveToFirst
```
public boolean moveToFirst(byte o)
```
    Description copied from interface: ByteOrderedSet
    
    A specific move method to move a given key to the first index.
    
    Specified by:
    
    moveToFirst in interface ByteOrderedSet
    
    Parameters:
    
    o - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(byte o)
```
    Description copied from interface: ByteOrderedSet
    
    A specific move method to move a given key to the last index.
    
    Specified by:
    
    moveToLast in interface ByteOrderedSet
    
    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: AbstractByteCollection
    
    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.Byte>
    
    Specified by:
    
    contains in interface java.util.Set<java.lang.Byte>
    
    Specified by:
    
    contains in interface ByteCollection
    
    Specified by:
    
    contains in interface ByteSet
    
    Overrides:
    
    contains in class AbstractByteCollection
  - firstByte
```
public byte firstByte()
```
    Description copied from interface: ByteOrderedSet
    
    A method to get the first element in the set
    
    Specified by:
    
    firstByte in interface ByteOrderedSet
    
    Returns:
    
    first element in the set
  - pollFirstByte
```
public byte pollFirstByte()
```
    Description copied from interface: ByteOrderedSet
    
    A method to get and remove the first element in the set
    
    Specified by:
    
    pollFirstByte in interface ByteOrderedSet
    
    Returns:
    
    first element in the set
  - lastByte
```
public byte lastByte()
```
    Description copied from interface: ByteOrderedSet
    
    A method to get the last element in the set
    
    Specified by:
    
    lastByte in interface ByteOrderedSet
    
    Returns:
    
    last element in the set
  - pollLastByte
```
public byte pollLastByte()
```
    Description copied from interface: ByteOrderedSet
    
    A method to get and remove the last element in the set
    
    Specified by:
    
    pollLastByte in interface ByteOrderedSet
    
    Returns:
    
    last element in the set
  - remove
```
public boolean remove(java.lang.Object o)
```
    Description copied from class: AbstractByteCollection
    
    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.Byte>
    
    Specified by:
    
    remove in interface java.util.Set<java.lang.Byte>
    
    Specified by:
    
    remove in interface ByteCollection
    
    Specified by:
    
    remove in interface ByteSet
    
    Overrides:
    
    remove in class AbstractByteCollection
  - contains
```
public boolean contains(byte o)
```
    Description copied from class: AbstractByteCollection
    
    A Type-Specific implementation of contains. This implementation iterates over the elements and returns true if the value match.
    
    Specified by:
    
    contains in interface ByteCollection
    
    Overrides:
    
    contains in class AbstractByteCollection
    
    Parameters:
    
    o - the element that should be searched for.
    
    Returns:
    
    true if the value was found.
  - remove
```
public boolean remove(byte o)
```
    Description copied from interface: ByteSet
    
    A Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface ByteSet
    
    Parameters:
    
    o - the element that should be removed
    
    Returns:
    
    true if the element was removed
  - forEach
```
public void forEach(ByteConsumer action)
```
    Description copied from interface: ByteIterable
    
    A Type Specific foreach function that reduces (un)boxing
    
    Specified by:
    
    forEach in interface ByteIterable
    
    Parameters:
    
    action - The action to be performed for each element
    
    See Also:
    
    Iterable.forEach(Consumer)
  - forEach
```
public <E> void forEach(E input,
                        ObjectByteConsumer<E> action)
```
    Description copied from interface: ByteIterable
    
    Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
    
    Specified by:
    
    forEach in interface ByteIterable
    
    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(Byte2BooleanFunction filter)
```
    Description copied from interface: ByteIterable
    
    Helper function to reduce stream usage that allows to filter for any matches.
    
    Specified by:
    
    matchesAny in interface ByteIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if any matches were found
  - matchesNone
```
public boolean matchesNone(Byte2BooleanFunction filter)
```
    Description copied from interface: ByteIterable
    
    Helper function to reduce stream usage that allows to filter for no matches.
    
    Specified by:
    
    matchesNone in interface ByteIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if no matches were found
  - matchesAll
```
public boolean matchesAll(Byte2BooleanFunction filter)
```
    Description copied from interface: ByteIterable
    
    Helper function to reduce stream usage that allows to filter for all matches.
    
    Specified by:
    
    matchesAll in interface ByteIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if all matches.
  - reduce
```
public byte reduce(byte identity,
                   ByteByteUnaryOperator operator)
```
    Description copied from interface: ByteIterable
    
    Performs a reduction on the elements of this Iterable
    
    Specified by:
    
    reduce in interface ByteIterable
    
    Parameters:
    
    identity - the start value
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns identity if nothing was found
  - reduce
```
public byte reduce(ByteByteUnaryOperator operator)
```
    Description copied from interface: ByteIterable
    
    Performs a reduction on the elements of this Iterable
    
    Specified by:
    
    reduce in interface ByteIterable
    
    Parameters:
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns null value if nothing was found
  - findFirst
```
public byte findFirst(Byte2BooleanFunction filter)
```
    Description copied from interface: ByteIterable
    
    Helper function to reduce stream usage that allows to filter for the first match.
    
    Specified by:
    
    findFirst in interface ByteIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the found value or the null equivalent variant.
  - count
```
public int count(Byte2BooleanFunction filter)
```
    Description copied from interface: ByteIterable
    
    Helper function to reduce stream usage that allows to count the valid elements.
    
    Specified by:
    
    count in interface ByteIterable
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the amount of Valid Elements
  - iterator
```
public ByteListIterator iterator()
```
    Description copied from interface: ByteCollection
    
    Returns a Type-Specific Iterator to reduce (un)boxing
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Byte>
    
    Specified by:
    
    iterator in interface java.util.Collection<java.lang.Byte>
    
    Specified by:
    
    iterator in interface java.util.Set<java.lang.Byte>
    
    Specified by:
    
    iterator in interface ByteCollection
    
    Specified by:
    
    iterator in interface ByteIterable
    
    Specified by:
    
    iterator in interface ByteOrderedSet
    
    Specified by:
    
    iterator in interface ByteSet
    
    Specified by:
    
    iterator in class AbstractByteSet
    
    Returns:
    
    a iterator of the collection
    
    See Also:
    
    Collection.iterator()
  - iterator
```
public ByteBidirectionalIterator iterator(byte fromElement)
```
    Description copied from interface: ByteOrderedSet
    
    A type Specific Iterator starting from a given key
    
    Specified by:
    
    iterator in interface ByteOrderedSet
    
    Parameters:
    
    fromElement - the element the iterator should start from
    
    Returns:
    
    a iterator starting from the given element
  - copy
```
public ImmutableByteOpenHashSet copy()
```
    Description copied from interface: ByteCollection
    
    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 ByteCollection
    
    Specified by:
    
    copy in interface ByteOrderedSet
    
    Specified by:
    
    copy in interface ByteSet
    
    Overrides:
    
    copy in class AbstractByteSet
    
    Returns:
    
    a Shallow Copy of the collection
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<java.lang.Byte>
    
    Specified by:
    
    clear in interface java.util.Set<java.lang.Byte>
    
    Overrides:
    
    clear in class java.util.AbstractCollection<java.lang.Byte>
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection<java.lang.Byte>
    
    Specified by:
    
    size in interface java.util.Set<java.lang.Byte>
    
    Specified by:
    
    size in class java.util.AbstractCollection<java.lang.Byte>

Class ImmutableByteOpenHashSet

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.bytes.sets.AbstractByteSet

Methods inherited from class speiger.src.collections.bytes.collections.AbstractByteCollection

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.bytes.sets.ByteOrderedSet

Methods inherited from interface speiger.src.collections.bytes.sets.ByteSet

Methods inherited from interface java.util.Set

Methods inherited from interface speiger.src.collections.bytes.collections.ByteCollection

Methods inherited from interface java.util.Collection

Methods inherited from interface speiger.src.collections.bytes.collections.ByteIterable

Constructor Detail

ImmutableByteOpenHashSet

ImmutableByteOpenHashSet

ImmutableByteOpenHashSet

ImmutableByteOpenHashSet

ImmutableByteOpenHashSet

ImmutableByteOpenHashSet

ImmutableByteOpenHashSet

ImmutableByteOpenHashSet

ImmutableByteOpenHashSet

ImmutableByteOpenHashSet

ImmutableByteOpenHashSet

ImmutableByteOpenHashSet

Method Detail

add

addAll

addAll

addAndMoveToFirst

addAndMoveToLast

moveToFirst

moveToLast

contains

firstByte

pollFirstByte

lastByte

pollLastByte

remove

contains

remove

forEach

forEach

matchesAny

matchesNone

matchesAll

reduce

reduce

findFirst

count

iterator

iterator

copy

clear

size