CharSet (char-sets 8.5.13-SNAPSHOT API)

All Superinterfaces:

it.unimi.dsi.fastutil.chars.CharCollection, it.unimi.dsi.fastutil.chars.CharIterable, java.util.Collection<java.lang.Character>, java.lang.Iterable<java.lang.Character>, java.util.Set<java.lang.Character>

All Known Subinterfaces:

CharSortedSet

All Known Implementing Classes:

AbstractCharSet, AbstractCharSortedSet, CharArraySet, CharAVLTreeSet, CharLinkedOpenCustomHashSet, CharLinkedOpenHashSet, CharOpenCustomHashSet, CharOpenHashSet, CharRBTreeSet, CharSets.EmptySet, CharSets.Singleton, CharSets.SynchronizedSet, CharSets.UnmodifiableSet, CharSortedSets.EmptySet, CharSortedSets.Singleton, CharSortedSets.SynchronizedSortedSet, CharSortedSets.UnmodifiableSortedSet
```
public interface CharSet
extends it.unimi.dsi.fastutil.chars.CharCollection, java.util.Set<java.lang.Character>
```
A type-specific Set; provides some additional methods that use polymorphism to avoid (un)boxing.
Additionally, this interface strengthens (again) iterator().

See Also:

Set

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default boolean`	`add(java.lang.Character o)` Deprecated. Please use the corresponding type-specific method instead.
`default boolean`	`contains(java.lang.Object o)` Deprecated. Please use the corresponding type-specific method instead.
`it.unimi.dsi.fastutil.chars.CharIterator`	`iterator()` Returns a type-specific iterator on the elements of this set.
`static CharSet`	`of()` Returns an immutable empty set.
`static CharSet`	`of(char... a)` Returns an immutable list with the elements given.
`static CharSet`	`of(char e)` Returns an immutable set with the element given.
`static CharSet`	`of(char e0, char e1)` Returns an immutable set with the elements given.
`static CharSet`	`of(char e0, char e1, char e2)` Returns an immutable set with the elements given.
`default boolean`	`rem(char k)` Deprecated. Please use `remove()` instead.
`boolean`	`remove(char k)` Removes an element from this set.
`default boolean`	`remove(java.lang.Object o)` Deprecated. Please use the corresponding type-specific method instead.
`default it.unimi.dsi.fastutil.chars.CharSpliterator`	`spliterator()` Returns a type-specific spliterator on the elements of this set.

Methods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection
add, addAll, contains, containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toArray, toCharArray, toCharArray

Methods inherited from interface it.unimi.dsi.fastutil.chars.CharIterable
forEach, forEach, forEach

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

- Method Detail
  - iterator
```
it.unimi.dsi.fastutil.chars.CharIterator iterator()
```
    Returns a type-specific iterator on the elements of this set.
    
    Specified by:
    
    iterator in interface it.unimi.dsi.fastutil.chars.CharCollection
    
    Specified by:
    
    iterator in interface it.unimi.dsi.fastutil.chars.CharIterable
    
    Specified by:
    
    iterator in interface java.util.Collection<java.lang.Character>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Character>
    
    Specified by:
    
    iterator in interface java.util.Set<java.lang.Character>
    
    Returns:
    
    a type-specific iterator on the elements of this set.
  - spliterator
```
default it.unimi.dsi.fastutil.chars.CharSpliterator spliterator()
```
    Returns a type-specific spliterator on the elements of this set.
    Set spliterators must report at least Spliterator.DISTINCT.
    See Set.spliterator() for more documentation on the requirements of the returned spliterator.
    
    Specified by:
    
    spliterator in interface it.unimi.dsi.fastutil.chars.CharCollection
    
    Specified by:
    
    spliterator in interface it.unimi.dsi.fastutil.chars.CharIterable
    
    Specified by:
    
    spliterator in interface java.util.Collection<java.lang.Character>
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<java.lang.Character>
    
    Specified by:
    
    spliterator in interface java.util.Set<java.lang.Character>
    
    Returns:
    
    Since:
    
    8.5.0
  - remove
```
boolean remove(char k)
```
    Removes an element from this set.
    
    See Also:
    
    Collection.remove(Object)
  - remove
```
@Deprecated
default boolean remove(java.lang.Object o)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    remove in interface it.unimi.dsi.fastutil.chars.CharCollection
    
    Specified by:
    
    remove in interface java.util.Collection<java.lang.Character>
    
    Specified by:
    
    remove in interface java.util.Set<java.lang.Character>
  - add
```
@Deprecated
default boolean add(java.lang.Character o)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    add in interface it.unimi.dsi.fastutil.chars.CharCollection
    
    Specified by:
    
    add in interface java.util.Collection<java.lang.Character>
    
    Specified by:
    
    add in interface java.util.Set<java.lang.Character>
  - contains
```
@Deprecated
default boolean contains(java.lang.Object o)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    contains in interface it.unimi.dsi.fastutil.chars.CharCollection
    
    Specified by:
    
    contains in interface java.util.Collection<java.lang.Character>
    
    Specified by:
    
    contains in interface java.util.Set<java.lang.Character>
  - rem
```
@Deprecated
default boolean rem(char k)
```
    Deprecated. Please use remove() instead.
    
    Removes an element from this set.
    This method is inherited from the type-specific collection this type-specific set is based on, but it should not used as this interface reinstates remove() as removal method.
    
    Specified by:
    
    rem in interface it.unimi.dsi.fastutil.chars.CharCollection
  - of
```
static CharSet of()
```
    Returns an immutable empty set.
    
    Returns:
    
    an immutable empty set.
  - of
```
static CharSet of(char e)
```
    Returns an immutable set with the element given.
    
    Parameters:
    
    e - an element.
    
    Returns:
    
    an immutable set containing e.
  - of
```
static CharSet of(char e0,
                  char e1)
```
    Returns an immutable set with the elements given.
    
    Parameters:
    
    e0 - the first element.
    
    e1 - the second element.
    
    Returns:
    
    an immutable set containing e0 and e1.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there were duplicate entries.
  - of
```
static CharSet of(char e0,
                  char e1,
                  char e2)
```
    Returns an immutable set with the elements given.
    
    Parameters:
    
    e0 - the first element.
    
    e1 - the second element.
    
    e2 - the third element.
    
    Returns:
    
    an immutable set containing e0, e1, and e2.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there were duplicate entries.
  - of
```
static CharSet of(char... a)
```
    Returns an immutable list with the elements given.
    
    Parameters:
    
    a - the list of elements that will be in the final set.
    
    Returns:
    
    an immutable set containing the elements in a.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there are any duplicate entries.

Interface CharSet

Method Summary

Methods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection

Methods inherited from interface it.unimi.dsi.fastutil.chars.CharIterable

Methods inherited from interface java.util.Set

Method Detail

iterator

spliterator

remove

remove

add

contains

rem

of

of

of

of

of