Collection
interface, to minimize the effort required to implement this interface.
To implement an unmodifiable collection, the programmer needs only to
extend this class and provide implementations for the iterator
and
size
methods. (The iterator returned by the iterator
method must implement hasNext
and next
.)
To implement a modifiable collection, the programmer must additionally
override this class's add
method (which otherwise throws an
UnsupportedOperationException
), and the iterator returned by the
iterator
method must additionally implement its remove
method.
The programmer should generally provide a void (no argument) and
Collection
constructor, as per the recommendation in the
Collection
interface specification.
The documentation for each non-abstract method in this class describes its implementation in detail. Each of these methods may be overridden if the collection being implemented admits a more efficient implementation.
This class is a member of the Java Collections Framework.
Collection
Access | Constructor and Description |
---|---|
protected |
Modifier and Type | Method and Description |
---|---|
public boolean | add(E
element whose presence in this collection is to be ensured e)Implements java. Ensures that this collection contains the specified element (optional operation). |
public boolean | addAll(Collection<? extends E>
collection containing elements to be added to this collection c)Implements java. Adds all of the elements in the specified collection to this collection (optional operation). |
public void | clear()
Implements java. Removes all of the elements from this collection (optional operation). |
public boolean | contains(Object
element whose presence in this collection is to be tested o)Implements java. Returns |
public boolean | containsAll(Collection<?>
collection to be checked for containment in this collection c)Implements java. Returns |
private static <T> T[] | Returns: array containing the elements in the given array, plus any further elements returned by the iterator, trimmed to sizethe array, replete with previously stored elements r, Iterator<?> the in-progress iterator over this collection it)Reallocates the array being used within toArray when the iterator returned more elements than expected, and finishes filling it from the iterator. |
public boolean | isEmpty()
Implements java. Returns |
public abstract Iterator | Returns: an iterator over the elements contained in this collectionRedeclares java. Returns an iterator over the elements contained in this collection. |
public boolean | remove(Object
element to be removed from this collection, if present o)Implements java. Removes a single instance of the specified element from this collection, if it is present (optional operation). |
public boolean | removeAll(Collection<?>
collection containing elements to be removed from this collection c)Implements java. Removes all of this collection's elements that are also contained in the specified collection (optional operation). |
public boolean | retainAll(Collection<?>
collection containing elements to be retained in this collection c)Implements java. Retains only the elements in this collection that are contained in the specified collection (optional operation). |
public abstract int | |
public Object[] | toArray()
Implements java. Returns an array containing all of the elements in this collection. |
public <T> T[] | toArray(T[]
the array into which the elements of this collection are to be
stored, if it is big enough; otherwise, a new array of the same
runtime type is allocated for this purpose. a)Implements java. Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. |
public String | Returns: a string representation of this collectionOverrides java. Returns a string representation of this collection. |
AbstractCollection | back to summary |
---|---|
protected AbstractCollection() Sole constructor. (For invocation by subclass constructors, typically implicit.) |
add | back to summary |
---|---|
public boolean add(E e) Implements java. Doc from java. Ensures that this collection contains the specified element (optional
operation). Returns
Collections that support this operation may place limitations on what
elements may be added to this collection. In particular, some
collections will refuse to add
If a collection refuses to add a particular element for any reason
other than that it already contains the element, it must throw
an exception (rather than returning Implementation Specification This implementation always throws an
|
addAll | back to summary |
---|---|
public boolean addAll(Collection<? extends E> c) Implements java. Doc from java. Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.) If the specified collection has a defined encounter order, processing of its elements generally occurs in that order. Implementation Specification This implementation iterates over the specified collection, and adds each object returned by the iterator to this collection, in turn. Note that this implementation will throw an
|
clear | back to summary |
---|---|
public void clear() Implements java. Doc from java. Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns. Implementation Specification This implementation iterates over this collection, removing each
element using the Note that this implementation will throw an
|
contains | back to summary |
---|---|
public boolean contains(Object o) Implements java. Doc from java. Returns Implementation Specification This implementation iterates over the elements in the collection, checking each element in turn for equality with the specified element.
|
containsAll | back to summary |
---|---|
public boolean containsAll(Collection<?> c) Implements java. Doc from java. Returns Implementation Specification This implementation iterates over the specified collection,
checking each element returned by the iterator in turn to see
if it's contained in this collection. If all elements are so
contained
|
finishToArray | back to summary |
---|---|
private static <T> T[] finishToArray(T[] r, Iterator<?> it) Reallocates the array being used within toArray when the iterator returned more elements than expected, and finishes filling it from the iterator.
|
isEmpty | back to summary |
---|---|
public boolean isEmpty() Implements java. Doc from java. Returns Implementation Specification This implementation returns
|
iterator | back to summary |
---|---|
public abstract Iterator Redeclares java. Returns an iterator over the elements contained in this collection.
|
remove | back to summary |
---|---|
public boolean remove(Object o) Implements java. Doc from java. Removes a single instance of the specified element from this
collection, if it is present (optional operation). More formally,
removes an element Implementation Specification This implementation iterates over the collection looking for the specified element. If it finds the element, it removes the element from the collection using the iterator's remove method. Note that this implementation throws an
|
removeAll | back to summary |
---|---|
public boolean removeAll(Collection<?> c) Implements java. Doc from java. Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection. Implementation Specification This implementation iterates over this collection, checking each
element returned by the iterator in turn to see if it's contained
in the specified collection. If it's so contained, it's removed from
this collection with the iterator's Note that this implementation will throw an
|
retainAll | back to summary |
---|---|
public boolean retainAll(Collection<?> c) Implements java. Doc from java. Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection. Implementation Specification This implementation iterates over this collection, checking each
element returned by the iterator in turn to see if it's contained
in the specified collection. If it's not so contained, it's removed
from this collection with the iterator's Note that this implementation will throw an
|
size | back to summary |
---|---|
public abstract int size() Redeclares java. Doc from java. Returns the number of elements in this collection. If this collection
contains more than
|
toArray | back to summary |
---|---|
public Object[] toArray() Implements java. Doc from java. Returns an array containing all of the elements in this collection.
If this collection makes any guarantees as to what order its elements
are returned by its iterator, this method must return the elements in
the same order. The returned array's runtime component type is The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array. Implementation Specification This implementation returns an array containing all the elements
returned by this collection's iterator, in the same order, stored in
consecutive elements of the array, starting with index This method is equivalent to:
|
toArray | back to summary |
---|---|
public <T> T[] toArray(T[] a) Implements java. Doc from java. Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection. If this collection fits in the specified array with room to spare
(i.e., the array has more elements than this collection), the element
in the array immediately following the end of the collection is set to
If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. Implementation Specification This implementation returns an array containing all the elements
returned by this collection's iterator in the same order, stored in
consecutive elements of the array, starting with index This method is equivalent to:
|
toString | back to summary |
---|---|
public String toString() Overrides java. Returns a string representation of this collection. The string
representation consists of a list of the collection's elements in the
order they are returned by its iterator, enclosed in square brackets
(
|