Package it.unimi.dsi.fastutil.chars

Class AbstractCharSet

java.lang.Object

java.util.AbstractCollection<Character>

it.unimi.dsi.fastutil.chars.AbstractCharCollection

it.unimi.dsi.fastutil.chars.AbstractCharSet

All Implemented Interfaces:

CharCollection, CharIterable, CharSet, Cloneable, Iterable<Character>, Collection<Character>, Set<Character>

Direct Known Subclasses:

AbstractCharSortedSet, CharArraySet, CharOpenCustomHashSet, CharOpenHashSet, CharSets.Singleton

public abstract class AbstractCharSet
extends AbstractCharCollection
implements Cloneable, CharSet

An abstract class providing basic methods for sets implementing a type-specific interface.

Note that the type-specific Set interface adds a type-specific remove() method, as it is no longer harmful for subclasses. Thus, concrete subclasses of this class must implement remove() (the rem() implementation of this class just delegates to remove()).

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()	Returns a hash code for this set.
abstract CharIterator	iterator()	Returns a type-specific iterator on the elements of this collection.
boolean	rem(char k)	Deprecated. Please use remove() instead.
boolean	remove(char k)	Removes an element from this set.

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharCollection

add, add, addAll, contains, contains, containsAll, remove, removeAll, retainAll, toArray, toCharArray, toCharArray, toString

Methods inherited from class java.util.AbstractCollection

addAll, clear, containsAll, isEmpty, removeAll, retainAll, size, toArray, toArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

add, addAll, contains, containsAll, removeAll, removeIf, removeIf, retainAll, toArray, toCharArray, toCharArray

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

forEach, forEach

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

add, contains, remove

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.Set

addAll, clear, containsAll, isEmpty, removeAll, retainAll, size, spliterator, toArray, toArray

Method Detail

iterator

public abstract CharIterator iterator()

Description copied from interface: CharCollection

Returns a type-specific iterator on the elements of this collection.

Note that this specification strengthens the one given in Iterable.iterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Collection.

Specified by:

iterator in interface CharCollection

Specified by:

iterator in interface CharIterable

Specified by:

iterator in interface CharSet

Specified by:

iterator in interface Collection<Character>

Specified by:

iterator in interface Iterable<Character>

Specified by:

iterator in interface Set<Character>

Specified by:

iterator in class AbstractCharCollection

Returns:

a type-specific iterator on the elements of this collection.

See Also:

Iterable.iterator()

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<Character>

Specified by:

equals in interface Set<Character>

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns a hash code for this set. The hash code of a set is computed by summing the hash codes of its elements.

Specified by:

hashCode in interface Collection<Character>

Specified by:

hashCode in interface Set<Character>

Overrides:

hashCode in class Object

Returns:

a hash code for this set.

remove

public boolean remove(char k)

Removes an element from this set.

Note that the corresponding method of a type-specific collection is rem(). This unfortunate situation is caused by the clash with the similarly named index-based method in the List interface. Delegates to the type-specific rem() method implemented by type-specific abstract Collection superclass.

Specified by:

remove in interface CharSet

See Also:

Collection.remove(Object)

rem

@Deprecated
public boolean rem(char k)

Deprecated.

Please use remove() instead.

Removes a single instance of the specified element from this collection, if it is present (optional operation).

Note that this method should be called remove(), but the clash with the similarly named index-based method in the List interface forces us to use a distinguished name. For simplicity, the set interfaces reinstates remove().

This implementation iterates over the elements in the collection, looking for the specified element and tries to remove it. Delegates to the type-specific remove() method specified in the type-specific Set interface.

Specified by:

rem in interface CharCollection

Specified by:

rem in interface CharSet

Overrides:

rem in class AbstractCharCollection

See Also:

Collection.remove(Object)