public interface Collection
All methods of this interface that are defined to modify the collection are defined as optional. An optional operation may throw an UnsupportedOperationException if the data backing this collection does not support such a modification. This may mean that the data structure is immutable, or that it is read-only but may change ("unmodifiable"), or that it is modifiable but of fixed size (such as an array), or any number of other combinations.
A class that wishes to implement this interface should consider subclassing AbstractCollection, which provides basic implementations of most of the methods of this interface. Classes that are prepared to make guarantees about ordering or about absence of duplicate elements should consider implementing List or Set respectively, both of which are subinterfaces of Collection.
A general-purpose implementation of the Collection interface should in most cases provide at least two constructors: One which takes no arguments and creates an empty collection, and one which takes a Collection as an argument and returns a collection containing the same elements (that is, creates a copy of the argument using its own implementation).
Modifier and Type | Method and Description |
---|---|
boolean |
add(Object o)
Add an element to this collection.
|
boolean |
addAll(Collection c)
Add the contents of a given collection to this collection.
|
void |
clear()
Clear the collection, such that a subsequent call to isEmpty() would
return true.
|
boolean |
contains(Object o)
Test whether this collection contains a given object as one of its
elements.
|
boolean |
containsAll(Collection c)
Test whether this collection contains every element in a given collection.
|
boolean |
equals(Object o)
Test whether this collection is equal to some object.
|
int |
hashCode()
Obtain a hash code for this collection.
|
boolean |
isEmpty()
Test whether this collection is empty, that is, if size() == 0.
|
Iterator |
iterator()
Obtain an Iterator over this collection.
|
boolean |
remove(Object o)
Remove a single occurrence of an object from this collection.
|
boolean |
removeAll(Collection c)
Remove all elements of a given collection from this collection.
|
boolean |
retainAll(Collection c)
Remove all elements of this collection that are not contained in a given
collection.
|
int |
size()
Get the number of elements in this collection.
|
Object[] |
toArray()
Copy the current contents of this collection into an array.
|
Object[] |
toArray(Object[] a)
Copy the current contents of this collection into an array.
|
boolean add(Object o)
o
- the object to add.UnsupportedOperationException
- if this collection does not
support the add operation.ClassCastException
- if o cannot be added to this collection due
to its type.IllegalArgumentException
- if o cannot be added to this
collection for some other reason.boolean addAll(Collection c)
c
- the collection to add.UnsupportedOperationException
- if this collection does not
support the addAll operation.ClassCastException
- if some element of c cannot be added to this
collection due to its type.IllegalArgumentException
- if some element of c cannot be added
to this collection for some other reason.void clear()
UnsupportedOperationException
- if this collection does not
support the clear operation.boolean contains(Object o)
o
- the element to look for.o == null ? e == null : o.equals(e)
.boolean containsAll(Collection c)
c
- the collection to test for.boolean equals(Object o)
If an implementation of Collection, which is not also an implementation of Set or List, should choose to implement this method, it should take care to obey the contract of the equals method of Object. In particular, care should be taken to return false when o is a Set or a List, in order to preserve the symmetry of the relation.
int hashCode()
If an implementation of Collection, which is not also an implementation of Set or List, should choose to implement this method, it should take care to obey the contract of the hashCode method of Object. Note that this method renders it impossible to correctly implement both Set and List, as the required implementations are mutually exclusive.
boolean isEmpty()
Iterator iterator()
boolean remove(Object o)
o == null ? e == null
: o.equals(e)
.o
- the object to remove.UnsupportedOperationException
- if this collection does not
support the remove operation.boolean removeAll(Collection c)
UnsupportedOperationException
- if this collection does not
support the removeAll operation.boolean retainAll(Collection c)
UnsupportedOperationException
- if this collection does not
support the retainAll operation.int size()
Object[] toArray()
Object[] toArray(Object[] a)
a
- the array to copy this collection into.ArrayStoreException
- if the type of any element of the
collection is not a subtype of the element type of a.