@GwtCompatible(emulated=true) public abstract class ImmutableCollection<E> extends AbstractCollection<E> implements Serializable
In addition to the Collection methods, this class has an asList() method, which returns a list view of the collection's elements.
Note: Although this class is not final, it cannot be subclassed outside of this package as it has no public or protected constructors. Thus, instances of this type are guaranteed to be immutable.
| Modifier and Type | Class and Description |
|---|---|
static class |
ImmutableCollection.Builder<E>
Abstract base class for builders of
ImmutableCollection types. |
| Modifier and Type | Method and Description |
|---|---|
boolean |
add(E e)
Deprecated.
Unsupported operation.
|
boolean |
addAll(Collection<? extends E> newElements)
Deprecated.
Unsupported operation.
|
ImmutableList<E> |
asList()
Returns a list view of the collection.
|
void |
clear()
Deprecated.
Unsupported operation.
|
boolean |
contains(Object object)
Returns true if this collection contains the specified element.
|
abstract UnmodifiableIterator<E> |
iterator()
Returns an unmodifiable iterator across the elements in this collection.
|
boolean |
remove(Object object)
Deprecated.
Unsupported operation.
|
boolean |
removeAll(Collection<?> oldElements)
Deprecated.
Unsupported operation.
|
boolean |
retainAll(Collection<?> elementsToKeep)
Deprecated.
Unsupported operation.
|
Object[] |
toArray()
Returns an array containing all of the elements in this collection.
|
<T> T[] |
toArray(T[] other)
Returns an array containing all of the elements in this collection;
the runtime type of the returned array is that of the specified array.
|
containsAll, isEmpty, size, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitequals, hashCodepublic abstract UnmodifiableIterator<E> iterator()
iterator in interface Iterable<E>iterator in interface Collection<E>iterator in class AbstractCollection<E>public final Object[] toArray()
java.util.AbstractCollectionThe 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.
This method acts as bridge between array-based and collection-based APIs.
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 0.
The length of the returned array is equal to the number of elements
returned by the iterator, even if the size of this collection changes
during iteration, as might happen if the collection permits
concurrent modification during iteration. The size method is
called only as an optimization hint; the correct result is returned
even if the iterator returns a different number of elements.
This method is equivalent to:
List<E> list = new ArrayList<E>(size());
for (E e : this)
list.add(e);
return list.toArray();
toArray in interface Collection<E>toArray in class AbstractCollection<E>public final <T> T[] toArray(T[] other)
java.util.AbstractCollectionIf 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 null. (This is useful in determining the length of this collection only if the caller knows that this 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 the Collection.toArray() method, 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 x is a collection known to contain only strings. The following code can be used to dump the collection into a newly allocated array of String:
String[] y = x.toArray(new String[0]);
Note that toArray(new Object[0]) is identical in function to
toArray().
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 0.
If the number of elements returned by the iterator is too large to
fit into the specified array, then the elements are returned in a
newly allocated array with length equal to the number of elements
returned by the iterator, even if the size of this collection
changes during iteration, as might happen if the collection permits
concurrent modification during iteration. The size method is
called only as an optimization hint; the correct result is returned
even if the iterator returns a different number of elements.
This method is equivalent to:
List<E> list = new ArrayList<E>(size());
for (E e : this)
list.add(e);
return list.toArray(a);
toArray in interface Collection<E>toArray in class AbstractCollection<E>other - 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.public boolean contains(@Nullable Object object)
java.util.AbstractCollectionThis implementation iterates over the elements in the collection, checking each element in turn for equality with the specified element.
contains in interface Collection<E>contains in class AbstractCollection<E>object - element whose presence in this collection is to be tested@Deprecated public final boolean add(E e)
add in interface Collection<E>add in class AbstractCollection<E>e - element whose presence in this collection is to be ensuredUnsupportedOperationException - always@Deprecated public final boolean remove(Object object)
remove in interface Collection<E>remove in class AbstractCollection<E>object - element to be removed from this collection, if presentUnsupportedOperationException - always@Deprecated public final boolean addAll(Collection<? extends E> newElements)
addAll in interface Collection<E>addAll in class AbstractCollection<E>newElements - collection containing elements to be added to this collectionUnsupportedOperationException - alwaysAbstractCollection.add(Object)@Deprecated public final boolean removeAll(Collection<?> oldElements)
removeAll in interface Collection<E>removeAll in class AbstractCollection<E>oldElements - collection containing elements to be removed from this collectionUnsupportedOperationException - alwaysAbstractCollection.remove(Object),
AbstractCollection.contains(Object)@Deprecated public final boolean retainAll(Collection<?> elementsToKeep)
retainAll in interface Collection<E>retainAll in class AbstractCollection<E>elementsToKeep - collection containing elements to be retained in this collectionUnsupportedOperationException - alwaysAbstractCollection.remove(Object),
AbstractCollection.contains(Object)@Deprecated public final void clear()
clear in interface Collection<E>clear in class AbstractCollection<E>UnsupportedOperationException - alwayspublic ImmutableList<E> asList()
Copyright © 2010-2013. All Rights Reserved.