Java Platform 1.2
Beta 4

Interface java.util.Collection

All Known Subinterfaces:
BeanContext, BeanContextServices, List, Set, SortedSet
All Known Implementing Classes:
AbstractCollection

public abstract interface Collection
The root interface in the collection hierarchy. A Collection represents a group of Objects, known as its elements. Bags (unordered collections that may contain duplicate elements) implement this interface directly, rather than implementing one of its "subinterfaces", List or Set.

The interfaces that comprise the collection hierarchy are designed to allow manipulation of collections in an implementation-independent fashion. This allows for interoperability among unrelated APIs that take collections as input or return them as output. It reduces the effort in learning new APIs that would otherwise have their own collection interfaces, reduces the effort in designing such APIs, and fosters software reuse.

The collection hierarchy consists of six interfaces, the core collection intefaces. Three of these interfaces, Set, List, and SortedSet are descendants of the Collection interface; they add further constraints on the contracts imposed by the methods in this interface, as well as adding new methods. The other two core collection interfaces, Map and SortedMap, are not descendants of Collection, as they represents mappings rather than true collections.

All of the methods in Collection and the other core interfaces that modify the collection are labeled optional. Some implementations may not perform one or more of these operations, throwing a runtime exception, UnsupportedOperationException, if they are attempted. Implementations should specify in their documentation which optional operations they support. Several terms are introduced to aid in this specification:

Some implementations may restrict what elements (or in the case of Maps, keys and values) may be stored. Possible restrictions include requiring elements to:

Attempting to add an element that violates an implementation's restrictions will result in a runtime exception, typically a ClassCastException, an IllegalArgumentException or a NullPointerException. Attempting to remove or test for such an element may result in such an exception, though some "restricted collections" may permit this usage.

All general-purpose Collection implementation classes should provide two "standard" constructors: a void (no arguments) constructor, which creates an empty Collection, and a constructor with a single argument of type Collection, which creates a new Collection with the same elements as its argument. In effect, the latter constructor allows the user to copy any Collection, producing an equivalent Collection of the desired implementation type. Similarly, all general-purpose Map implementations should provide a void (no arguments) constructor and a constructor that takes a single argument of type Map. There is no way to enforce these recommendations (as interfaces cannot contain constructors) but all of the general-purpose Collection and Map implementations in the JDK comply.

Collection implementation classes typically have names of the form <Implementation><Interface>. Set implementations in the JDK include HashSet and TreeSet. List implementations include ArrayList, LinkedList and Vector. Map implementations include HashMap, TreeMap, and Hashtable. (The JDK contains no class that implements Collection directly.)

The new (JDK1.2) general-purpose implementations of the collection interfaces are summarized in the table below:

  Implementations
Hash TableResizable ArrayBalanced TreeLinked List
Interfaces SetHashSet   TreeSet  
List   ArrayList   LinkedList
Map HashMap   TreeMap  

All of the new collection implementations have names of the form (<Implementation><Interface>). All are unsynchronized. The Collections class contains static factories that may be used to add synchronization to any unsynchronized collection. All of the new implementations have fail-fast iterators, which detect illegal concurrent modification, and fail quickly and cleanly.

The AbstractCollection, AbstractSet, AbstractList and AbstractSequentialList classes provide skeletal implementations of the core collection interfaces, to minimize the effort required to implement them. The Iterator, ListIterator, Comparable and Comparator interfaces provide the required "infrastructure."

Since:
JDK1.2
See Also:
Set, List, Map, SortedSet, SortedMap, HashSet, TreeSet, ArrayList, LinkedList, Vector, HashMap, TreeMap, Hashtable, Collections, Arrays, AbstractCollection, AbstractSet, AbstractList, AbstractSequentialList, AbstractMap, Iterator, ListIterator, Comparable, Comparator, UnsupportedOperationException, ConcurrentModificationException

Method Summary
 boolean add(Object o)
          Ensures that this Collection contains the specified element (optional operation).
 boolean addAll(Collection c)
          Adds all of the elements in the specified Collection to this Collection (optional operation).
 void clear()
          Removes all of the elements from this Collection (optional operation).
 boolean contains(Object o)
          Returns true if this Collection contains the specified element.
 boolean containsAll(Collection c)
          Returns true if this Collection contains all of the elements in the specified Collection.
 boolean equals(Object o)
          Compares the specified Object with this Collection for equality.
 int hashCode()
          Returns the hash code value for this Collection.
 boolean isEmpty()
          Returns true if this Collection contains no elements.
 Iterator iterator()
          Returns an Iterator over the elements in this Collection.
 boolean remove(Object o)
          Removes a single instance of the specified element from this Collection, if it is present (optional operation).
 boolean removeAll(Collection c)
          Removes from this Collection all of its elements that are contained in the specified Collection (optional operation).
 boolean retainAll(Collection c)
          Retains only the elements in this Collection that are contained in the specified Collection (optional operation).
 int size()
          Returns the number of elements in this Collection.
 Object[] toArray()
          Returns an array containing all of the elements in this Collection.
 Object[] toArray(Object[] a)
          Returns an array containing all of the elements in this Collection, whose runtime type is that of the specified array.
 

Method Detail

size

public int size()
Returns the number of elements in this Collection.
Returns:
the number of elements in this Collection.

isEmpty

public boolean isEmpty()
Returns true if this Collection contains no elements.

contains

public boolean contains(Object o)
Returns true if this Collection contains the specified element. More formally, returns true if and only if this Collection contains at least one element e such that (o==null ? e==null : o.equals(e)).
Parameters:
o - element whose presence in this Collection is to be tested.
Returns:
true if this Collection contains the specified element.

iterator

public Iterator iterator()
Returns an Iterator over the elements in this Collection. There are no guarantees concerning the order in which the elements are returned (unless this Collection is an instance of some class that provides a guarantee).

toArray

public Object[] toArray()
Returns an array containing all of the elements in this Collection. If the 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 will be "safe" in that no references to it are maintained by the Collection. (In other words, this method must allocate a new array even if the Collection is backed by an Array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and Collection-based APIs.

Returns:
an array containing all of the elements in this Collection.

toArray

public Object[] toArray(Object[] a)
Returns an array containing all of the elements in this Collection, whose runtime type 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 the Collection fits in the specified array with room to spare (i.e., the array has more elements than the Collection), the element in the array immediately following the end of the collection is set to null. This is useful in determining the length of the Collection only if the caller knows that the Collection does not contain any null elements.)

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.

Like toArray(), this method acts as bridge between array-based and Collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs

Suppose l is a List known to contain only strings. The following code can be used to dump the list into a newly allocated array of String:

 String[] x = (String[]) v.toArray(new String[0]);
 

Note that toArray(new Object[0]) is identical in function to toArray().

Parameters:
a - the array into which the elements of the Collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
Returns:
an array containing the elements of the Collection.
Throws:
ArrayStoreException - the runtime type of a is not a supertype of the runtime type of every element in this Collection.

add

public boolean add(Object o)
Ensures that this Collection contains the specified element (optional operation). Returns true if the Collection changed as a result of the call. (Returns false if this Collection does not permit duplicates and already contains the specified element.)

Collections that support this operation may place limitations on what elements may be added to the Collection. In particular, some Collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.

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 false). This preserves the invariant that a Collection always contains the specified element after this call returns.

Parameters:
o - element whose presence in this Collection is to be ensured.
Returns:
true if the Collection changed as a result of the call.
Throws:
UnsupportedOperationException - add is not supported by this Collection.
ClassCastException - class of the specified element prevents it from being added to this Collection.
IllegalArgumentException - some aspect of this element prevents it from being added to this Collection.

remove

public boolean remove(Object o)
Removes a single instance of the specified element from this Collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if the Collection contains one or more such elements. Returns true if the Collection contained the specified element (or equivalently, if the Collection changed as a result of the call).
Parameters:
o - element to be removed from this Collection, if present.
Returns:
true if the Collection changed as a result of the call.
Throws:
UnsupportedOperationException - remove is not supported by this Collection.

containsAll

public boolean containsAll(Collection c)
Returns true if this Collection contains all of the elements in the specified Collection.
Returns:
true if this Collection contains all of the elements in the specified Collection.
See Also:
contains(Object)

addAll

public boolean addAll(Collection c)
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 the specified Collection is this Collection, and this Collection is nonempty.)
Parameters:
c - elements to be inserted into this Collection.
Returns:
true if this Collection changed as a result of the call.
Throws:
UnsupportedOperationException - addAll is not supported by this Collection.
ClassCastException - class of an element of the specified Collection prevents it from being added to this Collection.
IllegalArgumentException - some aspect of an element of the specified Collection prevents it from being added to this Collection.
See Also:
add(Object)

removeAll

public boolean removeAll(Collection c)
Removes from this Collection all of its elements that are contained in the specified Collection (optional operation). After this call returns, this Collection will contains no elements in common with the specified Collection.
Parameters:
c - elements to be removed from this Collection.
Returns:
true if this Collection changed as a result of the call.
Throws:
UnsupportedOperationException - removeAll is not supported by this Collection.
See Also:
remove(Object), contains(Object)

retainAll

public boolean retainAll(Collection c)
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.
Parameters:
c - elements to be retained in this Collection.
Returns:
true if this Collection changed as a result of the call.
Throws:
UnsupportedOperationException - retainAll is not supported by this Collection.
See Also:
remove(Object), contains(Object)

clear

public void clear()
Removes all of the elements from this Collection (optional operation). The Collection will be empty after this call returns (unless it throws an exception).
Throws:
UnsupportedOperationException - clear is not supported by this Collection.

equals

public boolean equals(Object o)
Compares the specified Object with this Collection for equality.

While Collection adds no stipulations to the general contract for Object.equals, programmers who implement Collection "directly" (in other words, create a class that is a Collection but is not a Set or a List) must exercise care if they choose to override Object.equals. It is not necessary to do so, and the simplest course of action is to rely on Object's implementation, but the implementer may wish to implement a "value comparison" in place of the default "reference comparison." (Lists and Sets mandate such value comparisons.)

The general contract for Object.equals states that equals must be symmetric (in other words, a.equals(b) if and only if b.equals(a)). The contracts for List.equals and Set.equals state that Lists are only equal to other Lists, and Sets to other Sets. Thus, a custom equals method for a Collection class that implements neither a List nor a Set must return false when this Collection is compared to any List or Set. (By the same logic, it is not possible to write a class that correctly implements both the Set and List interfaces.)

Parameters:
o - Object to be compared for equality with this Collection.
Returns:
true if the specified Object is equal to this Collection.
Overrides:
equals in class Object
See Also:
Object.equals(Object), Set.equals(Object), List.equals(Object)

hashCode

public int hashCode()
Returns the hash code value for this Collection. While Collection adds no stipulations to the general contract for Object.hashCode, programmers should take note that any class that overrides Object.equals must also override Object.hashCode, in order to satisfy the general contract for Object.hashCode. In particular, c1.equals(c2) implies that c1.hashCode()==c2.hashCode().
Returns:
the hash code value for this Collection.
Overrides:
hashCode in class Object
See Also:
Object.hashCode(), Object.equals(Object)

Java Platform 1.2
Beta 4

Submit a bug or feature
Submit comments/suggestions about new javadoc look
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.
This documentation was generated with a post-Beta4 version of Javadoc.