Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java Platform 1.2
Beta 4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Class java.util.Collections

java.lang.Object
  |
  +--java.util.Collections

public class Collections

extends Object

This class consists exclusively of static methods that operate on or return Collections. It contains polymorphic algorithms that operate on collections, "views" and "wrappers", which return a new collection backed by a specified collection, and a few other odds and ends.

Since:

JDK1.2

See Also:

Collection, Set, List, Map

Field Summary

static List	EMPTY_LIST The empty List (immutable).
static Set	EMPTY_SET The empty Set (immutable).

Method Summary

static int	binarySearch(List list, Object key, Comparator c) Searches the specified List for the specified Object using the binary search algorithm.
static int	binarySearch(List list, Object key) Searches the specified List for the specified Object using the binary search algorithm.
static void	copy(List dest, List src) Copies all of the elements from one List into another.
static Enumeration	enumeration(Collection c) Returns an Enumeration over the specified Collection.
static void	fill(List list, Object o) Replaces all of the elements of the specified List with the specified element.
static Object	max(Collection coll, Comparator comp) Returns the maximum element of the given Collection, according to the order induced by the specified Comparator.
static Object	max(Collection coll) Returns the maximum element of the given Collection, according to the natural ordering of its elements.
static Object	min(Collection coll, Comparator comp) Returns the minimum element of the given Collection, according to the order induced by the specified Comparator.
static Object	min(Collection coll) Returns the minimum element of the given Collection, according to the natural ordering of its elements.
static List	nCopies(int n, Object o) Returns an immutable List consisting of n copies of the specified Object.
static void	reverse(List l) Reverses the order of the elements in the specified List.
static Comparator	reverseOrder() Returns a Comparator that imposes the reverse of the natural ordering on a collection of Comparable objects.
static void	shuffle(List list, Random rnd) Randomly permute the specified list using the specified source of randomness.
static void	shuffle(List list) Randomly permutes the specified list using a default source of randomness.
static Set	singleton(Object o) Returns an immutable Set containing only the specified Object.
static void	sort(List list, Comparator c) Sorts the specified List according to the order induced by the specified Comparator.
static void	sort(List list) Sorts the specified List into ascending order, according to the natural ordering of its elements.
static Collection	synchronizedCollection(Collection c) Returns a synchronized (thread-safe) Collection backed by the specified Collection.
static List	synchronizedList(List list) Returns a synchronized (thread-safe) List backed by the specified List.
static Map	synchronizedMap(Map m) Returns a synchronized (thread-safe) Map backed by the specified Map.
static Set	synchronizedSet(Set s) Returns a synchronized (thread-safe) Set backed by the specified Set.
static SortedMap	synchronizedSortedMap(SortedMap m) Returns a synchronized (thread-safe) SortedMap backed by the specified SortedMap.
static SortedSet	synchronizedSortedSet(SortedSet s) Returns a synchronized (thread-safe) SortedSet backed by the specified SortedSet.
static Collection	unmodifiableCollection(Collection c) Returns an unmodifiable view of the specified Collection.
static List	unmodifiableList(List list) Returns an unmodifiable view of the specified List.
static Map	unmodifiableMap(Map m) Returns an unmodifiable view of the specified Map.
static Set	unmodifiableSet(Set s) Returns an unmodifiable view of the specified Set.
static SortedMap	unmodifiableSortedMap(SortedMap m) Returns an unmodifiable view of the specified SortedMap.
static SortedSet	unmodifiableSortedSet(SortedSet s) Returns an unmodifiable view of the specified SortedSet.

Methods inherited from class java.lang.Object

clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait

Field Detail

EMPTY_SET

public static final Set EMPTY_SET

The empty Set (immutable).

EMPTY_LIST

public static final List EMPTY_LIST

The empty List (immutable).

Method Detail

sort

public static void sort(List list)

Sorts the specified List into ascending order, according to the natural ordering of its elements. All elements in the List must implement the Comparable interface. Furthermore, all elements in the List must be mutually comparable (that is, e1.compareTo(e2) must not throw a typeMismatchException for any elements e1 and e2 in the List).

This sort is guaranteed to be stable: equal elements will not be reordered as a result of the sort.

The sorting algorithm is a modified mergesort (in which the merge is omitted if the highest element in the low sublist is less than the lowest element in the high sublist). This algorithm offers guaranteed n log(n) performance, and can approach linear performance on nearly sorted lists.

The specified List must be modifiable, but need not be resizable. This implementation dumps the specified List into an List, sorts the array, and iterates over the List resetting each element from the corresponding position in the array. This avoids the n² log(n) performance that would result from attempting to sort a LinkedList in place.

Parameters:

list - the List to be sorted.

Throws:

ClassCastException - List contains elements that are not mutually comparable (for example, Strings and Integers).

UnsupportedOperationException - The specified List's ListIterator does not support the set operation.

See Also:

Comparable

sort

public static void sort(List list,
                        Comparator c)

Sorts the specified List according to the order induced by the specified Comparator. All elements in the List must be mutually comparable by the specified comparator (that is, comparator.compare(e1, e2) must not throw a typeMismatchException for any elements e1 and e2 in the List).

This sort is guaranteed to be stable: equal elements will not be reordered as a result of the sort.

The sorting algorithm is a modified mergesort (in which the merge is omitted if the highest element in the low sublist is less than the lowest element in the high sublist). This algorithm offers guaranteed n log(n) performance, and can approach linear performance on nearly sorted lists.

The specified List must be modifiable, but need not be resizable. This implementation dumps the specified List into an array, sorts the array, and iterates over the List resetting each element from the corresponding position in the array. This avoids the n² log(n) performance that would result from attempting to sort a LinkedList in place.

Parameters:

list - the List to be sorted.

Throws:

ClassCastException - List contains elements that are not mutually comparable with the specified Comparator.

UnsupportedOperationException - The specified List's ListIterator does not support the set operation.

See Also:

Comparator

binarySearch

public static int binarySearch(List list,
                               Object key)

Searches the specified List for the specified Object using the binary search algorithm. The List must be sorted into ascending order according to the natural ordering of its elements (as by Sort(List), above) prior to making this call. If it is not sorted, the results are undefined: in particular, the call may enter an infinite loop. If the List contains multiple elements equal to the specified Object, there is no guarantee which instance will be found.

This method runs in log(n) time for a "random access" List (which provides near-constant-time positional access). It may run in n log(n) time if it is called on a "sequential access" List (which provides linear-time positional access). If the specified List is an instanceof AbstracSequentialList, this method will do a sequential search instead of a binary search; this offers linear performance instead of n log(n) performance if this method is called on a LinkedList.

Parameters:

list - the List to be searched.

key - the key to be searched for.

Returns:

index of the search key, if it is contained in the List; otherwise, (-(insertion point) - 1). The insertion point is defined as the the point at which the value would be inserted into the List: the index of the first element greater than the value, or list.size(), if all elements in the List are less than the specified value. Note that this guarantees that the return value will be >= 0 if and only if the Object is found.

Throws:

ClassCastException - List contains elements that are not mutually comparable (for example, Strings and Integers), or the search key in not mutually comparable with the elements of the List.

See Also:

Comparable, sort(List)

binarySearch

public static int binarySearch(List list,
                               Object key,
                               Comparator c)

Searches the specified List for the specified Object using the binary search algorithm. The List must be sorted into ascending order according to the specified Comparator (as by Sort(List, Comparator), above), prior to making this call.

This method runs in log(n) time for a "random access" List (which provides near-constant-time positional access). It may run in n log(n) time if it is called on a "sequential access" List (which provides linear-time positional access). If the specified List is an instanceof AbstracSequentialList, this method will do a sequential search instead of a binary search; this offers linear performance instead of n log(n) performance if this method is called on a LinkedList.

Parameters:

list - the List to be searched.

key - the key to be searched for.

Returns:

index of the search key, if it is contained in the List; otherwise, (-(insertion point) - 1). The insertion point is defined as the the point at which the value would be inserted into the List: the index of the first element greater than the value, or list.size(), if all elements in the List are less than the specified value. Note that this guarantees that the return value will be >= 0 if and only if the Object is found.

Throws:

ClassCastException - List contains elements that are not mutually comparable with the specified Comparator, or the search key in not mutually comparable with the elements of the List using this Comparator.

See Also:

Comparable, sort(List, Comparator)

reverse

public static void reverse(List l)

Reverses the order of the elements in the specified List.

This method runs in linear time.

Parameters:

list - The List whose elements are to be reversed.

Throws:

UnsupportedOperationException - The specified List's ListIterator does not support the set operation.

shuffle

public static void shuffle(List list)

Randomly permutes the specified list using a default source of randomness. All permutations will occur with approximately equal likelihood.

The hedge "approximately" is used in the foregoing description because default source of randomenss is only approximately an unbiased source of independently chosen bits. If it were a perfect source of randomly chosen bits, then the algorithm would choose permutations with perfect uniformity.

This method runs in linear time for a "random access" List (which provides near-constant-time positional access). It may require quadratic time for a "sequential access" List.

Parameters:

list - The List to be shuffled.

Throws:

UnsupportedOperationException - The specified List's ListIterator does not support the set operation.

shuffle

public static void shuffle(List list,
                           Random rnd)

Randomly permute the specified list using the specified source of randomness. All permutations will occur with equal likelihood assuming that the source of randomness is fair.

This method runs in linear time for a "random access" List (which provides near-constant-time positional access). It may require quadratic time for a "sequential access" List.

Parameters:

list - the List to be shuffled.

r - the source of randomness to use to shuffle the List.

Throws:

UnsupportedOperationException - The specified List's ListIterator does not support the set operation.

fill

public static void fill(List list,
                        Object o)

Replaces all of the elements of the specified List with the specified element.

This method runs in linear time.

Parameters:

list - The List to be filled with the specified element.

o - The element with which to fill the specified List.

Throws:

UnsupportedOperationException - The specified List's ListIterator does not support the set operation.

copy

public static void copy(List dest,
                        List src)

Copies all of the elements from one List into another. After the operation, the index of each copied element in the destination List will be identical to its index in the source List. The destination list must be at least as long as the source list. If it is longer, the remaining elements in the destination list are unaffected.

This method runs in linear time.

Parameters:

dest - The destination List.

src - The source List.

Throws:

IndexOutOfBoundsException - the destination list is too small to contain the entire source List.

UnsupportedOperationException - The dest List's ListIterator does not support the set operation.

min

public static Object min(Collection coll)

Returns the minimum element of the given Collection, according to the natural ordering of its elements. All elements in the Collection must implement the Comparable interface. Furthermore, all elements in the Collection must be mutually comparable (that is, e1.compareTo(e2) must not throw a typeMismatchException for any elements e1 and e2 in the Collection).

This method iterates over the entire Collection, hence it requires time proportional to the size of the Collection.

Parameters:

coll - the collection whose minimum element is to be determined.

Returns:

the minimum element of the given Collection, according to the natural ordering of its elements.

Throws:

ClassCastException - Collection contains elements that are not mutually comparable (for example, Strings and Integers).

NoSuchElementException - Collection is empty.

See Also:

Comparable

min

public static Object min(Collection coll,
                         Comparator comp)

Returns the minimum element of the given Collection, according to the order induced by the specified Comparator. All elements in the Collection must be mutually comparable by the specified comparator (that is, comparator.compare(e1, e2) must not throw a typeMismatchException for any elements e1 and e2 in the Collection).

This method iterates over the entire Collection, hence it requires time proportional to the size of the Collection.

Parameters:

coll - the collection whose minimum element is to be determined.

Returns:

the minimum element of the given Collection, according to the specified Comparator.

Throws:

ClassCastException - Collection contains elements that are not mutually comparable with the specified Comparator.

NoSuchElementException - Collection is empty.

See Also:

Comparable

max

public static Object max(Collection coll)

Returns the maximum element of the given Collection, according to the natural ordering of its elements. All elements in the Collection must implement the Comparable interface. Furthermore, all elements in the Collection must be mutually comparable (that is, e1.compareTo(e2) must not throw a typeMismatchException for any elements e1 and e2 in the Collection).

This method iterates over the entire Collection, hence it requires time proportional to the size of the Collection.

Parameters:

coll - the collection whose maximum element is to be determined.

Returns:

the maximum element of the given Collection, according to the natural ordering of its elements.

Throws:

ClassCastException - Collection contains elements that are not mutually comparable (for example, Strings and Integers).

NoSuchElementException - Collection is empty.

See Also:

Comparable

max

public static Object max(Collection coll,
                         Comparator comp)

Returns the maximum element of the given Collection, according to the order induced by the specified Comparator. All elements in the Collection must be mutually comparable by the specified comparator (that is, comparator.compare(e1, e2) must not throw a typeMismatchException for any elements e1 and e2 in the Collection).

This method iterates over the entire Collection, hence it requires time proportional to the size of the Collection.

Parameters:

coll - the collection whose maximum element is to be determined.

Returns:

the maximum element of the given Collection, according to the specified Comparator.

Throws:

ClassCastException - Collection contains elements that are not mutually comparable with the specified Comparator.

NoSuchElementException - Collection is empty.

See Also:

Comparable

unmodifiableCollection

public static Collection unmodifiableCollection(Collection c)

Returns an unmodifiable view of the specified Collection. This method allows modules to provide users with "read-only" access to internal Collections. Query operations on the returned Collection "read through" to the specified Collection, and attempts to modify the returned Collection, whether direct or via its Iterator, result in an UnsupportedOperationException.

The returned Collection does not pass the hashCode and equals operations through to the backing Collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing Collection is a Set or a List.

The returned Collection will be Serializable if the specified Collection is Serializable.

Parameters:

c - the Collection for which an unmodifiable view is to be returned.

Returns:

an unmodifiable view of the specified Collection.

unmodifiableSet

public static Set unmodifiableSet(Set s)

Returns an unmodifiable view of the specified Set. This method allows modules to provide users with "read-only" access to internal Sets. Query operations on the returned Set "read through" to the specified Set, and attempts to modify the returned Set, whether direct or via its Iterator, result in an UnsupportedOperationException.

The returned Set will be Serializable if the specified Set is Serializable.

Parameters:

s - the Set for which an unmodifiable view is to be returned.

Returns:

an unmodifiable view of the specified Set.

unmodifiableSortedSet

public static SortedSet unmodifiableSortedSet(SortedSet s)

Returns an unmodifiable view of the specified SortedSet. This method allows modules to provide users with "read-only" access to internal SortedSets. Query operations on the returned SortedSet "read through" to the specified SortedSet. Attempts to modify the returned SortedSet, whether direct, via its Iterator, or via its subSet, headSet, or tailSet views, result in an UnsupportedOperationException.

The returned SortedSet will be Serializable if the specified SortedSet is Serializable.

Parameters:

s - the SortedSet for which an unmodifiable view is to be returned.

Returns:

an unmodifiable view of the specified SortedSet.

unmodifiableList

public static List unmodifiableList(List list)

Returns an unmodifiable view of the specified List. This method allows modules to provide users with "read-only" access to internal Lists. Query operations on the returned List "read through" to the specified List, and attempts to modify the returned List, whether direct or via its Iterator, result in an UnsupportedOperationException.

The returned List will be Serializable if the specified List is Serializable.

Parameters:

list - the List for which an unmodifiable view is to be returned.

Returns:

an unmodifiable view of the specified List.

unmodifiableMap

public static Map unmodifiableMap(Map m)

Returns an unmodifiable view of the specified Map. This method allows modules to provide users with "read-only" access to internal Maps. Query operations on the returned Map "read through" to the specified Map, and attempts to modify the returned Map, whether direct or via its Collection views, result in an UnsupportedOperationException.

The returned Map will be Serializable if the specified Map is Serializable.

Parameters:

m - the Map for which an unmodifiable view is to be returned.

Returns:

an unmodifiable view of the specified Map.

unmodifiableSortedMap

public static SortedMap unmodifiableSortedMap(SortedMap m)

Returns an unmodifiable view of the specified SortedMap. This method allows modules to provide users with "read-only" access to internal SortedMaps. Query operations on the returned SortedMap "read through" to the specified SortedMap. Attempts to modify the returned SortedMap, whether direct, via its Collection views, or via its subMap, headMap, or tailMap views, result in an UnsupportedOperationException.

The returned SortedMap will be Serializable if the specified SortedMap is Serializable.

Parameters:

m - the SortedMap for which an unmodifiable view is to be returned.

Returns:

an unmodifiable view of the specified SortedMap.

synchronizedCollection

public static Collection synchronizedCollection(Collection c)

Returns a synchronized (thread-safe) Collection backed by the specified Collection. In order to guarantee serial access, it is critical that all access to the backing Collection is accomplished through the returned Collection.

It is imperative that the user manually synchronize on the returned Collection when iterating over it:

  Collection c = Collections.synchronizedCollection(myCollection);
     ...
  synchronized(c) {
      Iterator i = c.iterator(); // Must be in the synchronized block
      while (i.hasNext())
         foo(i.next();
  }
 

Failure to follow this advice may result in non-deterministic behavior.

The returned Collection does not pass the hashCode and equals operations through to the backing Collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing Collection is a Set or a List.

The returned Collection will be Serializable if the specified Collection is Serializable.

Parameters:

c - the Collection to be "wrapped" in a synchronized Collection.

Returns:

a synchronized view of the specified Collection.

synchronizedSet

public static Set synchronizedSet(Set s)

Returns a synchronized (thread-safe) Set backed by the specified Set. In order to guarantee serial access, it is critical that all access to the backing Set is accomplished through the returned Set.

It is imperative that the user manually synchronize on the returned Set when iterating over it:

  Set s = Collections.synchronizedSet(new HashSet());
      ...
  synchronized(s) {
      Iterator i = s.iterator(); // Must be in the synchronized block
      while (i.hasNext())
          foo(i.next();
  }
 

Failure to follow this advice may result in non-deterministic behavior.

The returned Set will be Serializable if the specified Set is Serializable.

Parameters:

s - the Set to be "wrapped" in a synchronized Set.

Returns:

a synchronized view of the specified SortedSet.

synchronizedSortedSet

public static SortedSet synchronizedSortedSet(SortedSet s)

Returns a synchronized (thread-safe) SortedSet backed by the specified SortedSet. In order to guarantee serial access, it is critical that all access to the backing SortedSet is accomplished through the returned SortedSet (or its views).

It is imperative that the user manually synchronize on the returned SortedSet when iterating over it or any of its subSet, headSet, or tailSet views.

  SortedSet s = Collections.synchronizedSortedSet(new HashSortedSet());
      ...
  synchronized(s) {
      Iterator i = s.iterator(); // Must be in the synchronized block
      while (i.hasNext())
          foo(i.next();
  }
 

or:

  SortedSet s = Collections.synchronizedSortedSet(new HashSortedSet());
  SortedSet s2 = s.headSet(foo);
      ...
  synchronized(s) {  // Note: s, not s2!!!
      Iterator i = s2.iterator(); // Must be in the synchronized block
      while (i.hasNext())
          foo(i.next();
  }
 

Failure to follow this advice may result in non-deterministic behavior.

The returned SortedSet will be Serializable if the specified SortedSet is Serializable.

Parameters:

s - the SortedSet to be "wrapped" in a synchronized SortedSet.

Returns:

a synchronized view of the specified SortedSet.

synchronizedList

public static List synchronizedList(List list)

Returns a synchronized (thread-safe) List backed by the specified List. In order to guarantee serial access, it is critical that all access to the backing List is accomplished through the returned List.

It is imperative that the user manually synchronize on the returned List when iterating over it:

  List list = Collections.synchronizedList(new ArrayList());
      ...
  synchronized(list) {
      Iterator i = list.iterator(); // Must be in synchronized block
      while (i.hasNext())
          foo(i.next();
  }
 

Failure to follow this advice may result in non-deterministic behavior.

The returned List will be Serializable if the specified List is Serializable.

Parameters:

list - the List to be "wrapped" in a synchronized List.

Returns:

a synchronized view of the specified List.

synchronizedMap

public static Map synchronizedMap(Map m)

Returns a synchronized (thread-safe) Map backed by the specified Map. In order to guarantee serial access, it is critical that all access to the backing Map is accomplished through the returned Map.

It is imperative that the user manually synchronize on the returned Map when iterating over any of its Collection views:

  Map m = Collections.synchronizedMap(new HashMap());
      ...
  Set s = m.keySet();  // Needn't be in synchronized block
      ...
  synchronized(m) {  // Synchronizing on m, not s!
      Iterator i = s.iterator(); // Must be in synchronized block
      while (i.hasNext())
          foo(i.next();
  }
 

Failure to follow this advice may result in non-deterministic behavior.

The returned Map will be Serializable if the specified Map is Serializable.

Parameters:

m - the Map to be "wrapped" in a synchronized Map.

Returns:

a synchronized view of the specified Map.

synchronizedSortedMap

public static SortedMap synchronizedSortedMap(SortedMap m)

Returns a synchronized (thread-safe) SortedMap backed by the specified SortedMap. In order to guarantee serial access, it is critical that all access to the backing SortedMap is accomplished through the returned SortedMap (or its views).

It is imperative that the user manually synchronize on the returned SortedMap when iterating over any of its Collection views, or the Collections views of any of its subMap, headMap or tailMap views.

  SortedMap m = Collections.synchronizedSortedMap(new HashSortedMap());
      ...
  Set s = m.keySet();  // Needn't be in synchronized block
      ...
  synchronized(m) {  // Synchronizing on m, not s!
      Iterator i = s.iterator(); // Must be in synchronized block
      while (i.hasNext())
          foo(i.next();
  }
 

or:

  SortedMap m = Collections.synchronizedSortedMap(new HashSortedMap());
  SortedMap m2 = m.subMap(foo, bar);
      ...
  Set s2 = m2.keySet();  // Needn't be in synchronized block
      ...
  synchronized(m) {  // Synchronizing on m, not m2 or s2!
      Iterator i = s.iterator(); // Must be in synchronized block
      while (i.hasNext())
          foo(i.next();
  }
 

Failure to follow this advice may result in non-deterministic behavior.

The returned SortedMap will be Serializable if the specified SortedMap is Serializable.

Parameters:

m - the SortedMap to be "wrapped" in a synchronized SortedMap.

Returns:

a synchronized view of the specified SortedMap.

singleton

public static Set singleton(Object o)

Returns an immutable Set containing only the specified Object.

Returns:

an immutable Set containing only the specified Object.

nCopies

public static List nCopies(int n,
                           Object o)

Returns an immutable List consisting of n copies of the specified Object. The newly allocated data Object is tiny (it contains a single reference to the data Object). This method is useful in combination with List.addAll to grow Lists.

Parameters:

n - the number of elements in the returned List.

o - the element to appear repeatedly in the returned List.

Returns:

an immutable List consisting of n copies of the specified Object.

Throws:

IllegalArgumentException - n < 0.

See Also:

List.addAll(Collection), List.addAll(int, Collection)

reverseOrder

public static Comparator reverseOrder()

Returns a Comparator that imposes the reverse of the natural ordering on a collection of Comparable objects. (The natural ordering is the ordering imposed by the objects' own compareTo method.) This enables a simple idiom for sorting (or maintaining) collections (or arrays) of Comparable objects in reverse-natural-order. For example, suppose a is an array of String. Then:

 		Arrays.sort(a, Collections.REVERSE_ORDER);
 

sorts the array in reverse-lexicographic (alphabetical) order.

This Comparator is Serializable.

Returns:

a Comparator that imposes the reverse of the natural ordering on a collection of Comparable objects.

See Also:

Comparable

enumeration

public static Enumeration enumeration(Collection c)

Returns an Enumeration over the specified Collection. This provides interoperatbility with legacy APIs that require an Enumeration as input.

Parameters:

c - the Collection for which an Enumeration is to be returned.

Returns:

an Enumeration over the specified Collection.