it.unimi.dsi.fastutil.chars
Class AbstractCharCollection

java.lang.Object
  extended by it.unimi.dsi.fastutil.chars.AbstractCharCollection
All Implemented Interfaces:
CharCollection, CharIterable, java.lang.Iterable<java.lang.Character>, java.util.Collection<java.lang.Character>
Direct Known Subclasses:
AbstractCharList, AbstractCharSet, CharCollections.EmptyCollection

public abstract class AbstractCharCollection
extends java.lang.Object
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
 boolean add(char k)
           
 boolean add(java.lang.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(java.util.Collection<? extends java.lang.Character> c)
          Adds all elements of the given collection to this collection.
 CharIterator charIterator()
          Deprecated. 
 void clear()
           
 boolean contains(java.lang.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(java.util.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(java.lang.Object o)
          Delegates to the corresponding type-specific method.
 boolean remove(java.lang.Object ok)
           
 boolean removeAll(CharCollection c)
          Remove from this collection all elements in the given type-specific collection.
 boolean removeAll(java.util.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(java.util.Collection<?> c)
          Retains in this collection only elements from the given collection.
 java.lang.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.
 java.lang.String toString()
           
 
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
contains
 
Methods inherited from interface java.util.Collection
equals, hashCode, size
 

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[])

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)

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 java.lang.Object[] toArray()
Specified by:
toArray in interface java.util.Collection<java.lang.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 java.util.Collection<java.lang.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(java.util.Collection<? extends java.lang.Character> c)
Adds all elements of the given collection to this collection.

Specified by:
addAll in interface java.util.Collection<java.lang.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)

remove

public boolean remove(java.lang.Object ok)
Specified by:
remove in interface java.util.Collection<java.lang.Character>

clear

public void clear()
Specified by:
clear in interface java.util.Collection<java.lang.Character>

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 java.lang.Iterable<java.lang.Character>
Specified by:
iterator in interface java.util.Collection<java.lang.Character>
Returns:
a type-specific iterator on the elements of this collection.

add

public boolean add(java.lang.Character o)
Delegates to the corresponding type-specific method.

Specified by:
add in interface java.util.Collection<java.lang.Character>

rem

public boolean rem(java.lang.Object o)
Delegates to the corresponding type-specific method.


contains

public boolean contains(java.lang.Object o)
Delegates to the corresponding type-specific method.

Specified by:
contains in interface java.util.Collection<java.lang.Character>

containsAll

public boolean containsAll(java.util.Collection<?> c)
Checks whether this collection contains all elements from the given collection.

Specified by:
containsAll in interface java.util.Collection<java.lang.Character>
Parameters:
c - a collection.
Returns:
true if this collection contains all elements of the argument.

retainAll

public boolean retainAll(java.util.Collection<?> c)
Retains in this collection only elements from the given collection.

Specified by:
retainAll in interface java.util.Collection<java.lang.Character>
Parameters:
c - a collection.
Returns:
true if this collection changed as a result of the call.

removeAll

public boolean removeAll(java.util.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 java.util.Collection<java.lang.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 java.util.Collection<java.lang.Character>

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object