Package it.unimi.dsi.fastutil.chars

Class AbstractCharCollection

java.lang.Object

java.util.AbstractCollection<Character>

it.unimi.dsi.fastutil.chars.AbstractCharCollection

All Implemented Interfaces:

CharCollection, CharIterable, Iterable<Character>, Collection<Character>

Direct Known Subclasses:

AbstractCharBigList, AbstractCharList, AbstractCharSet, CharCollections.EmptyCollection, CharCollections.IterableCollection

public abstract class AbstractCharCollection
extends AbstractCollection<Character>
implements CharCollection

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

In particular, this class provide iterator(), add(), remove(Object) and contains(Object) methods that just call the type-specific counterpart.

Warning: Because of a name clash between the list and collection interfaces the type-specific deletion method of a type-specific abstract collection is rem(), rather then remove(). A subclass must thus override rem(), rather than remove(), to make all inherited methods work properly.

Method Summary

Modifier and Type	Method	Description
boolean	add(char k)	Ensures that this collection contains the specified element (optional operation).
boolean	add(Character key)	Deprecated. Please use the corresponding type-specific method instead.
boolean	addAll(CharCollection c)	Adds all elements of the given type-specific collection to this collection.
boolean	contains(char k)	Returns true if this collection contains the specified element.
boolean	contains(Object key)	Deprecated. Please use the corresponding type-specific method instead.
boolean	containsAll(CharCollection c)	Checks whether this collection contains all elements from the given type-specific collection.
abstract CharIterator	iterator()	Returns a type-specific iterator on the elements of this collection.
boolean	rem(char k)	Removes a single instance of the specified element from this collection, if it is present (optional operation).
boolean	remove(Object key)	Deprecated. Please use the corresponding type-specific method instead.
boolean	removeAll(CharCollection c)	Remove from this collection all elements in the given type-specific collection.
boolean	retainAll(CharCollection c)	Retains in this collection only elements from the given type-specific collection.
char[]	toArray(char[] a)	Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
char[]	toCharArray()	Returns a primitive type array containing the items of this collection.
char[]	toCharArray(char[] a)	Deprecated. Please use toArray() instead—this method is redundant and will be removed in the future.
String	toString()

Methods inherited from class java.util.AbstractCollection

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

removeIf, removeIf

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

forEach, forEach

Methods inherited from interface java.util.Collection

addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, retainAll, size, spliterator, stream, toArray, 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 Collection<Character>

Specified by:

iterator in interface Iterable<Character>

Specified by:

iterator in class AbstractCollection<Character>

Returns:

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

See Also:

Iterable.iterator()

add

public boolean add(char k)

Ensures that this collection contains the specified element (optional operation).

This implementation always throws an UnsupportedOperationException.

Specified by:

add in interface CharCollection

See Also:

Collection.add(Object)

contains

public boolean contains(char k)

Returns true if this collection contains the specified element.

This implementation iterates over the elements in the collection, looking for the specified element.

Specified by:

contains in interface CharCollection

See Also:

Collection.contains(Object)

rem

public boolean rem(char k)

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.

Specified by:

rem in interface CharCollection

See Also:

Collection.remove(Object)

add

@Deprecated
public boolean add(Character key)

Deprecated.

Please use the corresponding type-specific method instead.

Specified by:

add in interface CharCollection

Specified by:

add in interface Collection<Character>

Overrides:

add in class AbstractCollection<Character>

contains

@Deprecated
public boolean contains(Object key)

Deprecated.

Please use the corresponding type-specific method instead.

Specified by:

contains in interface CharCollection

Specified by:

contains in interface Collection<Character>

Overrides:

contains in class AbstractCollection<Character>

remove

@Deprecated
public boolean remove(Object key)

Deprecated.

Please use the corresponding type-specific method instead.

Specified by:

remove in interface CharCollection

Specified by:

remove in interface Collection<Character>

Overrides:

remove in class AbstractCollection<Character>

toArray

public char[] toArray(char[] a)

Description copied from interface: CharCollection

Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.

Note that, contrarily to Collection.toArray(Object[]), this methods just writes all elements of this collection: no special value will be added after the last one.

Specified by:

toArray in interface CharCollection

Parameters:

a - if this array is big enough, it will be used to store this collection.

Returns:

a primitive type array containing the items of this collection.

See Also:

Collection.toArray(Object[])

toCharArray

public char[] toCharArray()

Description copied from interface: CharCollection

Returns a primitive type array containing the items of this collection.

Specified by:

toCharArray in interface CharCollection

Returns:

a primitive type array containing the items of this collection.

See Also:

Collection.toArray()

toCharArray

@Deprecated
public char[] toCharArray(char[] a)

Deprecated.

Please use toArray() instead—this method is redundant and will be removed in the future.

Returns a primitive type array containing the items of this collection.

Note that, contrarily to Collection.toArray(Object[]), this methods just writes all elements of this collection: no special value will be added after the last one.

Specified by:

toCharArray in interface CharCollection

Parameters:

a - if this array is big enough, it will be used to store this collection.

Returns:

a primitive type array containing the items of this collection.

See Also:

Collection.toArray(Object[])

addAll

public boolean addAll(CharCollection c)

Description copied from interface: CharCollection

Adds all elements of the given type-specific collection to this collection.

Specified by:

addAll in interface CharCollection

Parameters:

c - a type-specific collection.

Returns:

true if this collection changed as a result of the call.

See Also:

Collection.addAll(Collection)

containsAll

public boolean containsAll(CharCollection c)

Description copied from interface: CharCollection

Checks whether this collection contains all elements from the given type-specific collection.

Specified by:

containsAll in interface CharCollection

Parameters:

c - a type-specific collection.

Returns:

true if this collection contains all elements of the argument.

See Also:

Collection.containsAll(Collection)

removeAll

public boolean removeAll(CharCollection c)

Description copied from interface: CharCollection

Remove from this collection all elements in the given type-specific collection.

Specified by:

removeAll in interface CharCollection

Parameters:

c - a type-specific collection.

Returns:

true if this collection changed as a result of the call.

See Also:

Collection.removeAll(Collection)

retainAll

public boolean retainAll(CharCollection c)

Description copied from interface: CharCollection

Retains in this collection only elements from the given type-specific collection.

Specified by:

retainAll in interface CharCollection

Parameters:

c - a type-specific collection.

Returns:

true if this collection changed as a result of the call.

See Also:

Collection.retainAll(Collection)

toString

public String toString()

Overrides:

toString in class AbstractCollection<Character>