Package gnu.trove.set

# Interface TCharSet

All Superinterfaces:
  `TCharCollection`

All Known Implementing Classes:
  `TCharByteHashMap.TKeyView`, `TCharCharHashMap.TKeyView`, `TCharDoubleHashMap.TKeyView`, `TCharFloatHashMap.TKeyView`, `TCharHashSet`, `TCharIntHashMap.TKeyView`, `TCharLongHashMap.TKeyView`, `TCharShortHashMap.TKeyView`

public interface TCharSet extends TCharCollection
An implementation of the `Set` interface that uses an open-addressed hash table to store its contents. Created: Sat Nov 3 10:38:17 2001

## Field Summary

### Fields inherited from interface gnu.trove.TCharCollection

`serialVersionUID`

## Method Summary

Modifier and Type
Method
Description
`boolean`
`add(char entry)`
Inserts a value into the set.
`boolean`
`addAll(char[] array)`
Adds all of the elements in the `array` to the set.
`boolean`
`addAll(TCharCollection collection)`
Adds all of the elements in the `TCharCollection` to the set.
`boolean`
`addAll(Collection<? extends Character> collection)`
Adds all of the elements in `collection` to the set.
`void`
`clear()`
Empties the set.
`boolean`
`contains(char entry)`
Returns `true` if this set contains the specified element.
`boolean`
`containsAll(char[] array)`
Tests the set to determine if all of the elements in `array` are present.
`boolean`
`containsAll(TCharCollection collection)`
Tests the set to determine if all of the elements in `TCharCollection` are present.
`boolean`
`containsAll(Collection<?> collection)`
Tests the set to determine if all of the elements in `collection` are present.
`boolean`
`equals(Object o)`
Compares the specified object with this set for equality.
`boolean`
`forEach(TCharProcedure procedure)`
Executes `procedure` for each element in the set.
`char`
`getNoEntryValue()`
Returns the value that is used to represent null.
`int`
`hashCode()`
Returns the hash code value for this set.
`boolean`
`isEmpty()`
Returns `true` if this set contains no elements.
`TCharIterator`
`iterator()`
Creates an iterator over the values of the set.
`boolean`
`remove(char entry)`
Removes `entry` from the set.
`boolean`
`removeAll(char[] array)`
Removes all of the elements in `array` from the set.
`boolean`
`removeAll(TCharCollection collection)`
Removes all of the elements in `TCharCollection` from the set.
`boolean`
`removeAll(Collection<?> collection)`
Removes all of the elements in `collection` from the set.
`boolean`
`retainAll(char[] array)`
Removes any values in the set which are not contained in `array`.
`boolean`
`retainAll(TCharCollection collection)`
Removes any values in the set which are not contained in `TCharCollection`.
`boolean`
`retainAll(Collection<?> collection)`
Removes any values in the set which are not contained in `collection`.
`int`
`size()`
Returns the number of elements in this set (its cardinality).
`char[]`
`toArray()`
Returns an array containing all of the elements in this set.
`char[]`
`toArray(char[] dest)`
Returns an array containing elements in this set.

## Method Details

### getNoEntryValue

char getNoEntryValue()
Returns the value that is used to represent null. The default value is generally zero, but can be changed during construction of the collection.

Specified by:
  `getNoEntryValue` in interface `TCharCollection`
Returns:
  the value that represents null

### size

int size()
Returns the number of elements in this set (its cardinality). If this set contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`.

Specified by:
  `size` in interface `TCharCollection`
Returns:
  the number of elements in this set (its cardinality)

### isEmpty

boolean isEmpty()
Returns `true` if this set contains no elements.

Specified by:
  `isEmpty` in interface `TCharCollection`
Returns:
  `true` if this set contains no elements

### contains

boolean contains(char entry)
Returns `true` if this set contains the specified element.

Specified by:
  `contains` in interface `TCharCollection`
Parameters:
  `entry` - an `char` value
Returns:
  true if the set contains the specified element.

### iterator

TCharIterator iterator()
Creates an iterator over the values of the set. The iterator supports element deletion.

Specified by:
  `iterator` in interface `TCharCollection`
Returns:
  an `TCharIterator` value

### toArray

char[] toArray()
Returns an array containing all of the elements in this set. If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this set. (In other words, this method must allocate a new array even if this set is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Specified by:
  `toArray` in interface `TCharCollection`
Returns:
  an array containing all the elements in this set

### toArray

char[] toArray(char[] dest)
Returns an array containing elements in this set.

If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set is set to ``getNoEntryValue()``. (This is useful in determining the length of this set only if the caller knows that this set does not contain any elements representing null.)

If the native array is smaller than the set size, the array will be filled with elements in Iterator order until it is full and exclude the remainder.

If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Specified by:
  `toArray` in interface `TCharCollection`
Parameters:
  `dest` - the array into which the elements of this set are to be stored.
Returns:
  an `char[]` containing all the elements in this set
Throws:
  `NullPointerException` - if the specified array is null

### add

boolean add(char entry)
Inserts a value into the set.

Specified by:
  `add` in interface `TCharCollection`
Parameters:
  `entry` - a `char` value
Returns:
  true if the set was modified by the add operation

### remove

boolean remove(char entry)
Removes `entry` from the set.

Specified by:
  `remove` in interface `TCharCollection`
Parameters:
  `entry` - an `char` value
Returns:
  true if the set was modified by the remove operation.

### containsAll

boolean containsAll(Collection<?> collection)
Tests the set to determine if all of the elements in `collection` are present.

Specified by:
  `containsAll` in interface `TCharCollection`
Parameters:
  `collection` - a `Collection` value
Returns:
  true if all elements were present in the set.

### containsAll

boolean containsAll(TCharCollection collection)
Tests the set to determine if all of the elements in `TCharCollection` are present.

Specified by:
  `containsAll` in interface `TCharCollection`
Parameters:
  `collection` - a `TCharCollection` value
Returns:
  true if all elements were present in the set.

### containsAll

boolean containsAll(char[] array)
Tests the set to determine if all of the elements in `array` are present.

Specified by:
  `containsAll` in interface `TCharCollection`
Parameters:
  `array` - as `array` of char primitives.
Returns:
  true if all elements were present in the set.

### addAll

boolean addAll(Collection<? extends Character> collection)
Adds all of the elements in `collection` to the set.

Specified by:
  `addAll` in interface `TCharCollection`
Parameters:
  `collection` - a `Collection` value
Returns:
  true if the set was modified by the add all operation.

### addAll

boolean addAll(TCharCollection collection)
Adds all of the elements in the `TCharCollection` to the set.

Specified by:
  `addAll` in interface `TCharCollection`
Parameters:
  `collection` - a `TCharCollection` value
Returns:
  true if the set was modified by the add all operation.

### addAll

boolean addAll(char[] array)
Adds all of the elements in the `array` to the set.

Specified by:
  `addAll` in interface `TCharCollection`
Parameters:
  `array` - a `array` of char primitives.
Returns:
  true if the set was modified by the add all operation.

### retainAll

boolean retainAll(Collection<?> collection)
Removes any values in the set which are not contained in `collection`.

Specified by:
  `retainAll` in interface `TCharCollection`
Parameters:
  `collection` - a `Collection` value
Returns:
  true if the set was modified by the retain all operation

### retainAll

boolean retainAll(TCharCollection collection)
Removes any values in the set which are not contained in `TCharCollection`.

Specified by:
  `retainAll` in interface `TCharCollection`
Parameters:
  `collection` - a `TCharCollection` value
Returns:
  true if the set was modified by the retain all operation

### retainAll

boolean retainAll(char[] array)
Removes any values in the set which are not contained in `array`.

Specified by:
  `retainAll` in interface `TCharCollection`
Parameters:
  `array` - an `array` of char primitives.
Returns:
  true if the set was modified by the retain all operation

### removeAll

boolean removeAll(Collection<?> collection)
Removes all of the elements in `collection` from the set.

Specified by:
  `removeAll` in interface `TCharCollection`
Parameters:
  `collection` - a `Collection` value
Returns:
  true if the set was modified by the remove all operation.

### removeAll

boolean removeAll(TCharCollection collection)
Removes all of the elements in `TCharCollection` from the set.

Specified by:
  `removeAll` in interface `TCharCollection`
Parameters:
  `collection` - a `TCharCollection` value
Returns:
  true if the set was modified by the remove all operation.

### removeAll

boolean removeAll(char[] array)
Removes all of the elements in `array` from the set.

Specified by:
  `removeAll` in interface `TCharCollection`
Parameters:
  `array` - an `array` of char primitives.
Returns:
  true if the set was modified by the remove all operation.

### clear

void clear()
Empties the set.

Specified by:
  `clear` in interface `TCharCollection`

### forEach

boolean forEach(TCharProcedure procedure)
Executes `procedure` for each element in the set.

Specified by:
  `forEach` in interface `TCharCollection`
Parameters:
  `procedure` - a `TCharProcedure` value
Returns:
  false if the loop over the set terminated because the procedure returned false for some value.

### equals

boolean equals(Object o)
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 `TCharCollection`
Overrides:
  `equals` in class `Object`
Parameters:
  `o` - object to be compared for equality with this set
Returns:
  `true` if the specified object is equal to this set

### hashCode

int hashCode()
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 elements in the set. This ensures that `s1.equals(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 `TCharCollection`
Overrides:
  `hashCode` in class `Object`
Returns:
  the hash code value for this set
See Also:
  - `Object.equals(Object)`
  - `Set.equals(Object)`