HashCharSet (LibJ Util 0.8.1 API)

java.lang.Object
- org.libj.util.primitive.HashPrimitiveSet
- - org.libj.util.primitive.HashCharSet

All Implemented Interfaces:

Serializable, Cloneable, CharCollection, CharIterable, CharSet, PrimitiveCollection
```
@Generated(value="Autogenerated by OpenJAX CodeGen Template (0.2.5)",
           date="2020-05-23")
public class HashCharSet
extends HashPrimitiveSet
implements CharSet
```
An CharSet implementing open-addressing (closed hashing) with linear-probing for collision resolution algorithm, with allocation-free operation in steady state when expanded.
This class replicates the API of the HashSet class by defining synonymous methods for a set of char values instead of Object references.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`HashCharSet()` Creates an empty `HashCharSet` with the default initial capacity (16) and the default load factor (0.55).
`HashCharSet(CharCollection c)` Creates a new `HashCharSet` with the same values as the specified collection.
`HashCharSet(Collection<Character> c)` Creates a new `HashCharSet` with the same values as the specified collection.
`HashCharSet(int initialCapacity)` Creates an empty `HashCharSet` with the specified initial capacity and the default load factor (0.55).
`HashCharSet(int initialCapacity, float loadFactor)` Creates an empty `HashCharSet` with the specified initial capacity and load factor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(char value)` Adds the specified value to this set if it is not already present.
`boolean`	`addAll(CharCollection c)` Adds all of the values in the specified collection to this set if they're not already present.
`boolean`	`addAll(Collection<Character> c)` Adds all of the values in the specified collection to this set if they're not already present.
`boolean`	`addAll(HashCharSet s)` Adds all of the values in the specified set to this set if they're not already present.
`void`	`clear()` Removes all of the values from this set.
`HashCharSet`	`clone()`
`void`	`compact()` Compact the backing arrays by rehashing with a capacity just larger than current size and giving consideration to the load factor.
`boolean`	`contains(char value)` Returns `true` if this set contains the specified value.
`boolean`	`containsAll(CharCollection c)` Returns `true` if this set contains all of the values of the specified collection.
`boolean`	`containsAll(Collection<Character> c)` Returns `true` if this set contains all of the values of the specified collection.
`boolean`	`equals(Object obj)` Compares the specified object with this set for equality.
`int`	`hashCode()` Returns the hash code value for this set.
`boolean`	`isEmpty()` Returns `true` if this set contains no values.
`CharIterator`	`iterator()` Returns an iterator over the values in this set.
`boolean`	`remove(char value)` Removes the specified value from this set if it is present.
`boolean`	`removeAll(char... a)` Removes all of this collection's values that are also contained in the specified vararg array.
`boolean`	`removeAll(CharCollection c)` Removes from this set all of its values that are contained in the specified collection.
`boolean`	`removeAll(Collection<Character> c)` Removes from this set all of its values that are contained in the specified collection.
`boolean`	`removeAll(HashCharSet s)` Removes from this set all of its values that are contained in the specified set.
`boolean`	`retainAll(CharCollection c)` Retains only the values in this set that are contained in the specified collection.
`boolean`	`retainAll(Collection<Character> c)` Retains only the values in this set that are contained in the specified collection.
`int`	`size()` Returns the number of values in this set (its cardinality).
`char[]`	`toArray(char[] a)` Returns an array containing all of the values in this collection in proper sequence (from first to last value).
`Character[]`	`toArray(Character[] a)` Returns an array containing all of the values in this collection in proper sequence (from first to last value).
`String`	`toString()`

Methods inherited from class org.libj.util.primitive.HashPrimitiveSet
findNextPositivePowerOfTwo, hash, nextIndex

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.libj.util.primitive.CharCollection
addAll, removeIf, toArray

- Constructor Detail
  - HashCharSet
```
public HashCharSet()
```
    Creates an empty HashCharSet with the default initial capacity (16) and the default load factor (0.55).
  - HashCharSet
```
public HashCharSet(int initialCapacity,
                   float loadFactor)
```
    Creates an empty HashCharSet with the specified initial capacity and load factor.
    
    Parameters:
    
    initialCapacity - The initial capacity.
    
    loadFactor - The load factor.
    
    Throws:
    
    IllegalArgumentException - If the initial capacity is negative or the load factor less than .1 or greater than .9.
  - HashCharSet
```
public HashCharSet(int initialCapacity)
```
    Creates an empty HashCharSet with the specified initial capacity and the default load factor (0.55).
    
    Parameters:
    
    initialCapacity - The initial capacity.
    
    Throws:
    
    IllegalArgumentException - If the initial capacity is negative.
  - HashCharSet
```
public HashCharSet(CharCollection c)
```
    Creates a new HashCharSet with the same values as the specified collection. The HashCharSet is created with default load factor (0.55) and an initial capacity sufficient to hold the mappings in the specified collection.
    
    Parameters:
    
    c - The collection whose values are to be added to this set.
    
    Throws:
    
    NullPointerException - If the specified set is null.
  - HashCharSet
```
public HashCharSet(Collection<Character> c)
```
    Creates a new HashCharSet with the same values as the specified collection. The HashCharSet is created with default load factor (0.55) and an initial capacity sufficient to hold the mappings in the specified collection.
    
    Parameters:
    
    c - The collection whose values are to be added to this set.
    
    Throws:
    
    NullPointerException - If the specified set is null.
- Method Detail
  - add
```
public boolean add(char value)
```
    Description copied from interface: CharSet
    
    Adds the specified value to this set if it is not already present. More formally, adds the specified value value to this set if the set contains no value value2 such that value == value2. If this set already contains the value, the call leaves the set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate values.
    
    Specified by:
    
    add in interface CharCollection
    
    Specified by:
    
    add in interface CharSet
    
    Parameters:
    
    value - Value to be added to this set.
    
    Returns:
    
    true if this set did not already contain the specified value.
  - addAll
```
public boolean addAll(CharCollection c)
```
    Description copied from interface: CharSet
    
    Adds all of the values in the specified collection to this set if they're not already present. If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.
    
    Specified by:
    
    addAll in interface CharCollection
    
    Specified by:
    
    addAll in interface CharSet
    
    Parameters:
    
    c - Collection containing values to be added to this set.
    
    Returns:
    
    true if this set changed as a result of the call.
    
    See Also:
    
    CharSet.addAll(Collection), CharSet.add(char)
  - addAll
```
public boolean addAll(Collection<Character> c)
```
    Description copied from interface: CharSet
    
    Adds all of the values in the specified collection to this set if they're not already present. If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.
    
    Specified by:
    
    addAll in interface CharCollection
    
    Specified by:
    
    addAll in interface CharSet
    
    Parameters:
    
    c - Collection containing values to be added to this set.
    
    Returns:
    
    true if this set changed as a result of the call.
    
    See Also:
    
    CharSet.addAll(CharCollection), CharSet.add(char)
  - addAll
```
public boolean addAll(HashCharSet s)
```
    Adds all of the values in the specified set to this set if they're not already present. The addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.
    
    Parameters:
    
    s - Set containing values to be added to this set.
    
    Returns:
    
    true if this set changed as a result of the call.
    
    Throws:
    
    NullPointerException - If the specified set is null.
    
    See Also:
    
    addAll(CharCollection), add(char)
  - contains
```
public boolean contains(char value)
```
    Description copied from interface: CharSet
    
    Returns true if this set contains the specified value. More formally, returns true if and only if this set contains a value v such that Objects.equals(value, v).
    
    Specified by:
    
    contains in interface CharCollection
    
    Specified by:
    
    contains in interface CharSet
    
    Parameters:
    
    value - Value whose presence in this set is to be tested.
    
    Returns:
    
    true if this set contains the specified value.
  - containsAll
```
public boolean containsAll(CharCollection c)
```
    Description copied from interface: CharSet
    
    Returns true if this set contains all of the values of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.
    
    Specified by:
    
    containsAll in interface CharCollection
    
    Specified by:
    
    containsAll in interface CharSet
    
    Parameters:
    
    c - Collection to be checked for containment in this set.
    
    Returns:
    
    true if this set contains all of the values of the specified collection.
    
    See Also:
    
    CharSet.containsAll(Collection), CharSet.contains(char)
  - containsAll
```
public boolean containsAll(Collection<Character> c)
```
    Description copied from interface: CharSet
    
    Returns true if this set contains all of the values of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.
    
    Specified by:
    
    containsAll in interface CharCollection
    
    Specified by:
    
    containsAll in interface CharSet
    
    Parameters:
    
    c - Collection to be checked for containment in this set.
    
    Returns:
    
    true if this set contains all of the values of the specified collection.
    
    See Also:
    
    CharSet.containsAll(CharCollection), CharSet.contains(char)
  - remove
```
public boolean remove(char value)
```
    Description copied from interface: CharSet
    
    Removes the specified value from this set if it is present. More formally, removes an value v such that Objects.equals(value, v), if this set contains such an value. Returns true if this set contained the value (or equivalently, if this set changed as a result of the call). (This set will not contain the value once the call returns).
    
    Specified by:
    
    remove in interface CharCollection
    
    Specified by:
    
    remove in interface CharSet
    
    Parameters:
    
    value - Value to be removed from this set, if present.
    
    Returns:
    
    true if this set contained the specified value.
  - removeAll
```
public boolean removeAll(char... a)
```
    Description copied from interface: CharCollection
    
    Removes all of this collection's values that are also contained in the specified vararg array. After this call returns, this collection will contain no values in common with the specified array.
    
    Specified by:
    
    removeAll in interface CharCollection
    
    Parameters:
    
    a - Array containing values to be removed from this collection.
    
    Returns:
    
    true if this collection changed as a result of the call.
    
    See Also:
    
    CharCollection.remove(char), CharCollection.contains(char)
  - removeAll
```
public boolean removeAll(CharCollection c)
```
    Description copied from interface: CharSet
    
    Removes from this set all of its values that are contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.
    
    Specified by:
    
    removeAll in interface CharCollection
    
    Specified by:
    
    removeAll in interface CharSet
    
    Parameters:
    
    c - Collection containing values to be removed from this set.
    
    Returns:
    
    true if this set changed as a result of the call.
    
    See Also:
    
    CharSet.removeAll(Collection), CharSet.remove(char), CharSet.contains(char)
  - removeAll
```
public boolean removeAll(Collection<Character> c)
```
    Description copied from interface: CharSet
    
    Removes from this set all of its values that are contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.
    
    Specified by:
    
    removeAll in interface CharCollection
    
    Specified by:
    
    removeAll in interface CharSet
    
    Parameters:
    
    c - Collection containing values to be removed from this set.
    
    Returns:
    
    true if this set changed as a result of the call.
    
    See Also:
    
    CharSet.removeAll(CharCollection), CharSet.remove(char), CharSet.contains(char)
  - removeAll
```
public boolean removeAll(HashCharSet s)
```
    Removes from this set all of its values that are contained in the specified set. This operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.
    
    Parameters:
    
    s - Set containing values to be removed from this set.
    
    Returns:
    
    true if this set changed as a result of the call.
    
    Throws:
    
    NullPointerException - If the specified collection is null.
    
    See Also:
    
    removeAll(CharCollection), remove(char), contains(char)
  - retainAll
```
public boolean retainAll(CharCollection c)
```
    Description copied from interface: CharSet
    
    Retains only the values in this set that are contained in the specified collection. In other words, removes from this set all of its values that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.
    
    Specified by:
    
    retainAll in interface CharCollection
    
    Specified by:
    
    retainAll in interface CharSet
    
    Parameters:
    
    c - Collection containing values to be retained in this set.
    
    Returns:
    
    true if this set changed as a result of the call.
    
    See Also:
    
    CharSet.retainAll(Collection), CharSet.remove(char), CharSet.contains(char)
  - retainAll
```
public boolean retainAll(Collection<Character> c)
```
    Description copied from interface: CharSet
    
    Retains only the values in this set that are contained in the specified collection. In other words, removes from this set all of its values that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.
    
    Specified by:
    
    retainAll in interface CharCollection
    
    Specified by:
    
    retainAll in interface CharSet
    
    Parameters:
    
    c - Collection containing values to be retained in this set.
    
    Returns:
    
    true if this set changed as a result of the call.
    
    See Also:
    
    CharSet.retainAll(CharCollection), CharSet.remove(char), CharSet.contains(char)
  - clear
```
public void clear()
```
    Description copied from interface: CharSet
    
    Removes all of the values from this set. The set will be empty after this call returns.
    
    Specified by:
    
    clear in interface CharSet
    
    Specified by:
    
    clear in interface PrimitiveCollection
  - size
```
public int size()
```
    Description copied from interface: CharSet
    
    Returns the number of values in this set (its cardinality). If this set contains more than Character.MAX_VALUE values, returns Character.MAX_VALUE.
    
    Specified by:
    
    size in interface CharSet
    
    Specified by:
    
    size in interface PrimitiveCollection
    
    Returns:
    
    The number of values in this set (its cardinality).
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: CharSet
    
    Returns true if this set contains no values.
    
    Specified by:
    
    isEmpty in interface CharSet
    
    Specified by:
    
    isEmpty in interface PrimitiveCollection
    
    Returns:
    
    true if this set contains no values.
  - toArray
```
public char[] toArray(char[] a)
```
    Description copied from interface: CharCollection
    
    Returns an array containing all of the values in this collection in proper sequence (from first to last value). If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the size of this collection.
    If the collection fits in the specified array with room to spare (i.e., the array has more values than the collection), the value in the array immediately following the end of the collection is set to 0. (This is useful in determining the length of the collection only if the caller knows that the collection does not contain any 0 values).
    
    Specified by:
    
    toArray in interface CharCollection
    
    Parameters:
    
    a - The array into which the values of the collection are to be stored. If the array is not big enough to store the values, a new array is allocated.
    
    Returns:
    
    An array containing the values of the collection.
  - toArray
```
public Character[] toArray(Character[] a)
```
    Description copied from interface: CharCollection
    
    Returns an array containing all of the values in this collection in proper sequence (from first to last value). If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the size of this collection.
    If the collection fits in the specified array with room to spare (i.e., the array has more values than the collection), the value in the array immediately following the end of the collection is set to null.
    
    Specified by:
    
    toArray in interface CharCollection
    
    Parameters:
    
    a - The array into which the values of the collection are to be stored. If the array is not big enough to store the values, a new array is allocated.
    
    Returns:
    
    An array containing the values of the collection.
  - iterator
```
public CharIterator iterator()
```
    Description copied from interface: CharSet
    
    Returns an iterator over the values in this set. The values are returned in no particular order (unless this set is an instance of some class that provides a guarantee).
    
    Specified by:
    
    iterator in interface CharIterable
    
    Specified by:
    
    iterator in interface CharSet
    
    Returns:
    
    An iterator over the values in this set.
  - compact
```
public void compact()
```
    Compact the backing arrays by rehashing with a capacity just larger than current size and giving consideration to the load factor.
  - clone
```
public HashCharSet clone()
```
    Overrides:
    
    clone in class Object
  - equals
```
public boolean equals(Object obj)
```
    Description copied from interface: CharSet
    
    Compares the specified object with this set for equality. Returns true if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface.
    
    Specified by:
    
    equals in interface CharSet
    
    Specified by:
    
    equals in interface PrimitiveCollection
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - Object to be compared for equality with this set.
    
    Returns:
    
    true if the specified object is equal to this set.
    
    See Also:
    
    Object.equals(Object), IntSet.equals(Object), IntList.equals(Object)
  - hashCode
```
public int hashCode()
```
    Description copied from interface: CharSet
    
    Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the values in the set. This ensures that s1 == s2 implies that s1.hashCode() == s2.hashCode() for any two sets s1 and s2, as required by the general contract of Object.hashCode().
    
    Specified by:
    
    hashCode in interface CharSet
    
    Specified by:
    
    hashCode in interface PrimitiveCollection
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    The hash code value for this set.
    
    See Also:
    
    Object.equals(Object), CharSet.equals(Object)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class HashCharSet

Constructor Summary

Method Summary

Methods inherited from class org.libj.util.primitive.HashPrimitiveSet

Methods inherited from class java.lang.Object

Methods inherited from interface org.libj.util.primitive.CharCollection

Constructor Detail

HashCharSet

HashCharSet

HashCharSet

HashCharSet

HashCharSet

Method Detail

add

addAll

addAll

addAll

contains

containsAll

containsAll

remove

removeAll

removeAll

removeAll

removeAll

retainAll

retainAll

clear

size

isEmpty

toArray

toArray

iterator

compact

clone

equals

hashCode

toString