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.

Method Summary

Modifier and Type	Method and Description
boolean	add(char k)
boolean	add(Character o) Delegates to the corresponding type-specific method.
boolean	addAll(CharCollection c) Adds all elements of the given type-specific collection to this collection.
boolean	addAll(Collection<? extends Character> c) Adds all elements of the given collection to this collection.
CharIterator	charIterator() Deprecated.
boolean	contains(char k)
boolean	contains(Object o) Delegates to the corresponding type-specific method.
boolean	containsAll(CharCollection c) Checks whether this collection contains all elements from the given type-specific collection.
boolean	containsAll(Collection<?> c) Checks whether this collection contains all elements from the given collection.
boolean	isEmpty()
abstract CharIterator	iterator() Returns a type-specific iterator on the elements of this collection.
boolean	rem(char k) 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.
boolean	rem(Object o) Delegates to the corresponding type-specific method.
boolean	remove(Object ok) Delegates to the type-specific rem() method.
boolean	removeAll(CharCollection c) Remove from this collection all elements in the given type-specific collection.
boolean	removeAll(Collection<?> c) Remove from this collection all elements in the given collection.
boolean	retainAll(CharCollection c) Retains in this collection only elements from the given type-specific collection.
boolean	retainAll(Collection<?> c) Retains in this collection only elements from the given collection.
Object[]	toArray()
char[]	toArray(char[] a) Returns a primitive type array containing the items of this collection.
<T> T[]	toArray(T[] a) Returns an containing the items of 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) Returns a primitive type array containing the items of this collection.
String	toString()

Methods inherited from class java.util.AbstractCollection

clear, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

clear, equals, hashCode, parallelStream, removeIf, size, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

toArray

public char[] toArray(char[] a)

Description copied from interface: CharCollection

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:

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

public char[] toCharArray(char[] a)

Description copied from interface: CharCollection

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)

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)

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)

retainAll

public boolean retainAll(CharCollection c)

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)

removeAll

public boolean removeAll(CharCollection c)

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)

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<Character>

Overrides:

toArray in class AbstractCollection<Character>

toArray

public <T> T[] toArray(T[] a)

Description copied from interface: CharCollection

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

Warning: 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

Specified by:

toArray in interface Collection<Character>

Overrides:

toArray in class AbstractCollection<Character>

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(Collection<? extends Character> c)

Adds all elements of the given collection to this collection.

Specified by:

addAll in interface Collection<Character>

Overrides:

addAll in class AbstractCollection<Character>

Parameters:

c - a collection.

Returns:

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

add

public boolean add(char k)

Specified by:

add in interface CharCollection

See Also:

Collection.add(Object)

charIterator

@Deprecated
public CharIterator charIterator()

Deprecated.

Delegates to the new covariantly stronger generic method.

Specified by:

charIterator in interface CharCollection

See Also:

CharCollection.iterator()

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 Iterable<Character>

Specified by:

iterator in interface Collection<Character>

Specified by:

iterator in class AbstractCollection<Character>

Returns:

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

remove

public boolean remove(Object ok)

Delegates to the type-specific rem() method.

Specified by:

remove in interface Collection<Character>

Overrides:

remove in class AbstractCollection<Character>

add

public boolean add(Character o)

Delegates to the corresponding type-specific method.

Specified by:

add in interface Collection<Character>

Overrides:

add in class AbstractCollection<Character>

rem

public boolean rem(Object o)

Delegates to the corresponding type-specific method.

contains

public boolean contains(Object o)

Delegates to the corresponding type-specific method.

Specified by:

contains in interface Collection<Character>

Overrides:

contains in class AbstractCollection<Character>

contains

public boolean contains(char k)

Specified by:

contains in interface CharCollection

See Also:

Collection.contains(Object)

rem

public boolean rem(char k)

Description copied from interface: CharCollection

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().

Specified by:

rem in interface CharCollection

See Also:

Collection.remove(Object)

containsAll

public boolean containsAll(Collection<?> c)

Checks whether this collection contains all elements from the given collection.

Specified by:

containsAll in interface Collection<Character>

Overrides:

containsAll in class AbstractCollection<Character>

Parameters:

c - a collection.

Returns:

true if this collection contains all elements of the argument.

retainAll

public boolean retainAll(Collection<?> c)

Retains in this collection only elements from the given collection.

Specified by:

retainAll in interface Collection<Character>

Overrides:

retainAll in class AbstractCollection<Character>

Parameters:

c - a collection.

Returns:

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

removeAll

public boolean removeAll(Collection<?> c)

Remove from this collection all elements in the given collection. If the collection is an instance of this class, it uses faster iterators.

Specified by:

removeAll in interface Collection<Character>

Overrides:

removeAll in class AbstractCollection<Character>

Parameters:

c - a collection.

Returns:

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

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<Character>

Overrides:

isEmpty in class AbstractCollection<Character>

toString

public String toString()

Overrides:

toString in class AbstractCollection<Character>