Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

java.util
Class Collections.UnmodifiableCollection  view Collections.UnmodifiableCollection download Collections.UnmodifiableCollection.java

java.lang.Object
  extended byjava.util.Collections.UnmodifiableCollection
All Implemented Interfaces:
Collection, java.lang.Iterable, java.io.Serializable
Direct Known Subclasses:
Collections.UnmodifiableList, Collections.UnmodifiableSet
Enclosing class:
Collections

private static class Collections.UnmodifiableCollection
extends java.lang.Object
implements Collection, java.io.Serializable

The implementation of Collections.unmodifiableCollection(Collection) 55 . This class name is required for compatibility with Sun's JDK serializability.


Field Summary
(package private)  Collection c
          The wrapped collection.
private static long serialVersionUID
          Compatible with JDK 1.4.
 
Constructor Summary
(package private) Collections.UnmodifiableCollection(Collection c)
          Wrap a given collection.
 
Method Summary
 boolean add(java.lang.Object o)
          Blocks the addition of elements to the underlying collection.
 boolean addAll(Collection c)
          Blocks the addition of a collection of elements to the underlying collection.
 void clear()
          Blocks the clearing of the underlying collection.
 boolean contains(java.lang.Object o)
          Test whether the underlying collection contains a given object as one of its elements.
 boolean containsAll(Collection c1)
          Test whether the underlying collection contains every element in a given collection.
 boolean isEmpty()
          Tests whether the underlying collection is empty, that is, if size() == 0.
 Iterator iterator()
          Obtain an Iterator over the underlying collection, which maintains its unmodifiable nature.
 boolean remove(java.lang.Object o)
          Blocks the removal of an object from the underlying collection.
 boolean removeAll(Collection c)
          Blocks the removal of a collection of objects from the underlying collection.
 boolean retainAll(Collection c)
          Blocks the removal of all elements from the underlying collection, except those in the supplied collection.
 int size()
          Retrieves the number of elements in the underlying collection.
 java.lang.Object[] toArray()
          Copy the current contents of the underlying collection into an array.
 java.lang.Object[] toArray(java.lang.Object[] a)
          Copy the current contents of the underlying collection into an array.
 java.lang.String toString()
          A textual representation of the unmodifiable collection.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Collection
equals, hashCode
 

Field Detail

serialVersionUID

private static final long serialVersionUID
Compatible with JDK 1.4.

See Also:
Constant Field Values

c

final Collection c
The wrapped collection. Package visible for use by subclasses.

Constructor Detail

Collections.UnmodifiableCollection

Collections.UnmodifiableCollection(Collection c)
Wrap a given collection.

Method Detail

add

public boolean add(java.lang.Object o)
Blocks the addition of elements to the underlying collection. This method never returns, throwing an exception instead.

Specified by:
add in interface Collection

addAll

public boolean addAll(Collection c)
Blocks the addition of a collection of elements to the underlying collection. This method never returns, throwing an exception instead.

Specified by:
addAll in interface Collection

clear

public void clear()
Blocks the clearing of the underlying collection. This method never returns, throwing an exception instead.

Specified by:
clear in interface Collection

contains

public boolean contains(java.lang.Object o)
Test whether the underlying collection contains a given object as one of its elements.

Specified by:
contains in interface Collection

containsAll

public boolean containsAll(Collection c1)
Test whether the underlying collection contains every element in a given collection.

Specified by:
containsAll in interface Collection

isEmpty

public boolean isEmpty()
Tests whether the underlying collection is empty, that is, if size() == 0.

Specified by:
isEmpty in interface Collection

iterator

public Iterator iterator()
Obtain an Iterator over the underlying collection, which maintains its unmodifiable nature.

Specified by:
iterator in interface Collection

remove

public boolean remove(java.lang.Object o)
Blocks the removal of an object from the underlying collection. This method never returns, throwing an exception instead.

Specified by:
remove in interface Collection

removeAll

public boolean removeAll(Collection c)
Blocks the removal of a collection of objects from the underlying collection. This method never returns, throwing an exception instead.

Specified by:
removeAll in interface Collection

retainAll

public boolean retainAll(Collection c)
Blocks the removal of all elements from the underlying collection, except those in the supplied collection. This method never returns, throwing an exception instead.

Specified by:
retainAll in interface Collection

size

public int size()
Retrieves the number of elements in the underlying collection.

Specified by:
size in interface Collection

toArray

public java.lang.Object[] toArray()
Copy the current contents of the underlying collection into an array.

Specified by:
toArray in interface Collection

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)
Copy the current contents of the underlying collection into an array. If the array passed as an argument has length less than the size of the underlying collection, an array of the same run-time type as a, with a length equal to the size of the underlying collection, is allocated using reflection. Otherwise, a itself is used. The elements of the underlying collection are copied into it, and if there is space in the array, the following element is set to null. The resultant array is returned. Note: The fact that the following element is set to null is only useful if it is known that this collection does not contain any null elements.

Specified by:
toArray in interface Collection

toString

public java.lang.String toString()
A textual representation of the unmodifiable collection.