ImmutableCharOpenHashSet (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractCollection<java.lang.Character>
- - speiger.src.collections.chars.collections.AbstractCharCollection
  - - speiger.src.collections.chars.sets.AbstractCharSet
    - - speiger.src.collections.chars.sets.ImmutableCharOpenHashSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Character>, java.util.Collection<java.lang.Character>, java.util.Set<java.lang.Character>, CharCollection, CharIterable, CharOrderedSet, CharSet
```
public class ImmutableCharOpenHashSet
extends AbstractCharSet
implements CharOrderedSet
```
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
`ImmutableCharOpenHashSet(char[] array)` Helper constructor that allow to create a set from unboxed values
`ImmutableCharOpenHashSet(char[] array, float loadFactor)` Helper constructor that allow to create a set from unboxed values
`ImmutableCharOpenHashSet(char[] array, int offset, int length)` Helper constructor that allow to create a set from unboxed values
`ImmutableCharOpenHashSet(char[] array, int offset, int length, float loadFactor)` Helper constructor that allow to create a set from unboxed values
`ImmutableCharOpenHashSet(CharCollection collection)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`ImmutableCharOpenHashSet(CharCollection collection, float loadFactor)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`ImmutableCharOpenHashSet(CharIterator iterator)` A Helper constructor that allows to create a set from a iterator of an unknown size
`ImmutableCharOpenHashSet(CharIterator iterator, float loadFactor)` A Helper constructor that allows to create a set from a iterator of an unknown size
`ImmutableCharOpenHashSet(java.util.Collection<? extends java.lang.Character> collection)` Deprecated.
`ImmutableCharOpenHashSet(java.util.Collection<? extends java.lang.Character> collection, float loadFactor)` Deprecated.
`ImmutableCharOpenHashSet(java.util.Iterator<java.lang.Character> iterator)` A Helper constructor that allows to create a set from a iterator of an unknown size
`ImmutableCharOpenHashSet(java.util.Iterator<java.lang.Character> 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(char o)` A Type-Specific add function to reduce (un)boxing
`boolean`	`addAll(CharCollection c)` A Type-Specific addAll function to reduce (un)boxing
`boolean`	`addAll(java.util.Collection<? extends java.lang.Character> c)` Deprecated.
`boolean`	`addAndMoveToFirst(char o)` A customized add method that allows you to insert into the first index.
`boolean`	`addAndMoveToLast(char o)` A customized add method that allows you to insert into the last index.
`void`	`clear()`
`boolean`	`contains(char o)` A Type-Specific implementation of contains.
`boolean`	`contains(java.lang.Object o)` This default implementation delegates to the corresponding type-specific function.
`ImmutableCharOpenHashSet`	`copy()` A Function that does a shallow clone of the Collection itself.
`int`	`count(Char2BooleanFunction filter)` Helper function to reduce stream usage that allows to count the valid elements.
`char`	`findFirst(Char2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for the first match.
`char`	`firstChar()` A method to get the first element in the set
`void`	`forEach(CharConsumer action)` A Type Specific foreach function that reduces (un)boxing
`<E> void`	`forEach(E input, ObjectCharConsumer<E> action)` Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
`CharListIterator`	`iterator()` Returns a Type-Specific Iterator to reduce (un)boxing
`CharBidirectionalIterator`	`iterator(char fromElement)` A type Specific Iterator starting from a given key
`char`	`lastChar()` A method to get the last element in the set
`boolean`	`matchesAll(Char2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for all matches.
`boolean`	`matchesAny(Char2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for any matches.
`boolean`	`matchesNone(Char2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for no matches.
`boolean`	`moveToFirst(char o)` A specific move method to move a given key to the first index.
`boolean`	`moveToLast(char o)` A specific move method to move a given key to the last index.
`char`	`pollFirstChar()` A method to get and remove the first element in the set
`char`	`pollLastChar()` A method to get and remove the last element in the set
`char`	`reduce(char identity, CharCharUnaryOperator operator)` Performs a reduction on the elements of this Iterable
`char`	`reduce(CharCharUnaryOperator operator)` Performs a reduction on the elements of this Iterable
`boolean`	`remove(char 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.chars.sets.AbstractCharSet
equals, hashCode

Methods inherited from class speiger.src.collections.chars.collections.AbstractCharCollection
add, containsAll, containsAll, containsAny, containsAny, remChar, removeAll, removeAll, retainAll, retainAll, toCharArray, toCharArray

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.chars.sets.CharOrderedSet
spliterator, synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.chars.sets.CharSet
add, remChar

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

Methods inherited from interface speiger.src.collections.chars.collections.CharCollection
addAll, addAll, addAll, containsAll, containsAny, containsAny, parallelPrimitiveStream, pour, primitiveStream, remIf, removeAll, removeAll, removeIf, retainAll, retainAll, toCharArray, toCharArray

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

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

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

Class ImmutableCharOpenHashSet

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.chars.sets.AbstractCharSet

Methods inherited from class speiger.src.collections.chars.collections.AbstractCharCollection

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.chars.sets.CharOrderedSet

Methods inherited from interface speiger.src.collections.chars.sets.CharSet

Methods inherited from interface java.util.Set

Methods inherited from interface speiger.src.collections.chars.collections.CharCollection

Methods inherited from interface java.util.Collection

Methods inherited from interface speiger.src.collections.chars.collections.CharIterable

Constructor Detail

ImmutableCharOpenHashSet

ImmutableCharOpenHashSet

ImmutableCharOpenHashSet

ImmutableCharOpenHashSet

ImmutableCharOpenHashSet

ImmutableCharOpenHashSet

ImmutableCharOpenHashSet

ImmutableCharOpenHashSet

ImmutableCharOpenHashSet

ImmutableCharOpenHashSet

ImmutableCharOpenHashSet

ImmutableCharOpenHashSet

Method Detail

add

addAll

addAll

addAndMoveToFirst

addAndMoveToLast

moveToFirst

moveToLast

contains

firstChar

pollFirstChar

lastChar

pollLastChar

remove

contains

remove

forEach

forEach

matchesAny

matchesNone

matchesAll

reduce

reduce

findFirst

count

iterator

iterator

copy

clear

size