|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.collections.primitives.AbstractCharCollection
public abstract class AbstractCharCollection
Abstract base class for CharCollection
s.
iterator()
and size()
. Mutable subclasses
should also override add(char)
and
CharIterator.remove
.
All other methods have at least some base implementation
derived from these. Subclasses may choose to override
these methods to provide a more efficient implementation.
Constructor Summary | |
---|---|
protected |
AbstractCharCollection()
|
Method Summary | |
---|---|
boolean |
add(char element)
Unsupported in this base implementation. |
boolean |
addAll(CharCollection c)
Adds all of the elements in the
specified collection to me (optional operation). |
void |
clear()
Removes all my elements (optional operation). |
boolean |
contains(char element)
Returns true iff I contain
the specified element. |
boolean |
containsAll(CharCollection c)
Returns true iff I contain
all of the elements in the given collection. |
boolean |
isEmpty()
Returns true iff I contain no elements. |
abstract CharIterator |
iterator()
Returns an iterator over all my elements. |
boolean |
removeAll(CharCollection c)
Removes all of my elements that are contained in the specified collection (optional operation). |
boolean |
removeElement(char element)
Removes a single occurrence of the specified element (optional operation). |
boolean |
retainAll(CharCollection c)
Removes all of my elements that are not contained in the specified collection (optional operation). |
abstract int |
size()
Returns the number of elements I contain. |
char[] |
toArray()
Returns an array containing all of my elements. |
char[] |
toArray(char[] a)
Returns an array containing all of my elements, using the given array if it is large enough. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected AbstractCharCollection()
Method Detail |
---|
public abstract CharIterator iterator()
CharCollection
iterator
over all my elements.
This base interface places no constraints on the order
in which the elements are returned by the returned iterator.
iterator
in interface CharCollection
iterator
over all my elements.public abstract int size()
CharCollection
size
in interface CharCollection
public boolean add(char element)
add
in interface CharCollection
element
- the value whose presence within me is to be ensured
true
iff I changed as a result of this callpublic boolean addAll(CharCollection c)
CharCollection
Adds
all of the elements in the
specified collection to me (optional operation).
addAll
in interface CharCollection
c
- the collection of elements whose presence within me is to
be ensured
true
iff I changed as a result of this callpublic void clear()
CharCollection
empty
after this
method successfully returns.
clear
in interface CharCollection
public boolean contains(char element)
CharCollection
true
iff I contain
the specified element.
contains
in interface CharCollection
element
- the value whose presence within me is to be tested
true
iff I contain the specified elementpublic boolean containsAll(CharCollection c)
CharCollection
true
iff I contain
all of the elements in the given collection.
containsAll
in interface CharCollection
c
- the collection of elements whose presence within me is to
be tested
true
iff I contain the all the specified elementspublic boolean isEmpty()
CharCollection
true
iff I contain no elements.
isEmpty
in interface CharCollection
true
iff I contain no elements.public boolean removeElement(char element)
CharCollection
removeElement
in interface CharCollection
element
- the element to remove, if present
true
iff I contained the specified element,
in other words, iff I changed as a result of this callpublic boolean removeAll(CharCollection c)
CharCollection
removeAll
in interface CharCollection
c
- the collection of elements to remove
true
iff I contained the at least one of the
specified elements, in other words, returns true
iff I changed as a result of this callpublic boolean retainAll(CharCollection c)
CharCollection
retainAll
in interface CharCollection
c
- the collection of elements to retain
true
iff I changed as a result
of this callpublic char[] toArray()
CharCollection
size
.
The returned array will be independent of me,
so that callers may modify that
returned array without modifying this collection.
When I guarantee the order in which
elements are returned by an iterator
,
the returned array will contain elements in the
same order.
toArray
in interface CharCollection
public char[] toArray(char[] a)
CharCollection
iterator
,
the returned array will contain elements in the
same order.
toArray
in interface CharCollection
a
- an array that may be used to contain the elements
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |