| org.apache.commons.collections.primitives.CharCollection
All known Subclasses: org.apache.commons.collections.primitives.AbstractCharCollection, org.apache.commons.collections.primitives.decorators.BaseProxyCharCollection, org.apache.commons.collections.primitives.adapters.AbstractCollectionCharCollection,
| Method Summary | |
| boolean | add(char element)
Ensures that I contain the specified element
(optional operation). | | boolean | addAll(CharCollection c)
CharCollection.add 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
CharCollection.contains contain all of the elements in the given collection. | | boolean | isEmpty()
Returns true iff I contain no elements. | | CharIterator | iterator()
Returns an
CharIterator 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). | | 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. |
| add | | boolean add(char element)(Code) | | Ensures that I contain the specified element
(optional operation). Returns true
iff I changed as a result of this call.
If a collection refuses to add the specified
element for any reason other than that it already contains
the element, it must throw an exception (rather than
simply returning false). This preserves the invariant
that a collection always contains the specified element after
this call returns.
Parameters:
element - the value whose presence within me is to be ensured true iff I changed as a result of this call
throws:
UnsupportedOperationException - when this operation is not supported
throws:
IllegalArgumentException - may be thrown if some aspect of the specified element prevents it from being added to me |
| addAll | | boolean addAll(CharCollection c)(Code) | | CharCollection.add Adds all of the elements in the
specified collection to me (optional operation).
Parameters:
c - the collection of elements whose presence within me is to be ensured true iff I changed as a result of this call
throws:
UnsupportedOperationException - when this operation is not supported
throws:
IllegalArgumentException - may be thrown if some aspect of some specified element prevents it from being added to me |
| contains | | boolean contains(char element)(Code) | | Returns true iff I contain
the specified element.
Parameters:
element - the value whose presence within me is to be tested true iff I contain the specified element |
| containsAll | | boolean containsAll(CharCollection c)(Code) | | Returns true iff I
CharCollection.contains contain all of the elements in the given collection.
Parameters:
c - the collection of elements whose presence within me is to be tested true iff I contain the all the specified elements |
| isEmpty | | boolean isEmpty()(Code) | | Returns true iff I contain no elements.
true iff I contain no elements. |
| iterator | | CharIterator iterator()(Code) | | Returns an
CharIterator iterator over all my elements.
This base interface places no constraints on the order
in which the elements are returned by the returned iterator.
an CharIterator iterator over all my elements. |
| removeAll | | boolean removeAll(CharCollection c)(Code) | | Removes all of my elements that are contained in the
specified collection (optional operation).
The behavior of this method is unspecified if
the given collection is modified while this method
is executing. Note that this includes the case
in which the given collection is this collection,
and it is not empty.
Parameters:
c - the collection of elements to remove true iff I contained the at least one of thespecified elements, in other words, returns trueiff I changed as a result of this call
throws:
UnsupportedOperationException - when this operation is not supported |
| removeElement | | boolean removeElement(char element)(Code) | | Removes a single occurrence of the specified element
(optional operation).
Parameters:
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 call
throws:
UnsupportedOperationException - when this operation is not supported |
| retainAll | | boolean retainAll(CharCollection c)(Code) | | Removes all of my elements that are not contained in the
specified collection (optional operation).
(In other words, retains only my elements that are
contained in the specified collection.)
The behavior of this method is unspecified if
the given collection is modified while this method
is executing.
Parameters:
c - the collection of elements to retain true iff I changed as a result of this call
throws:
UnsupportedOperationException - when this operation is not supported |
| size | | int size()(Code) | | Returns the number of elements I contain.
the number of elements I contain |
| toArray | | char[] toArray()(Code) | | Returns an array containing all of my elements.
The length of the returned array will be equal
to my
CharCollection.size 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
CharCollection.iterator iterator ,
the returned array will contain elements in the
same order.
an array containing all my elements |
| toArray | | char[] toArray(char[] a)(Code) | | Returns an array containing all of my elements,
using the given array if it is large
enough. When the length of the given array is
larger than the number of elements I contain,
values outside of my range will be unchanged.
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
CharCollection.iterator iterator ,
the returned array will contain elements in the
same order.
Parameters:
a - an array that may be used to contain the elements an array containing all my elements |
|
|