ImmutableCollection

java.lang.Object
- java.util.AbstractCollection<E>
- - com.google.common.collect.ImmutableCollection<E>

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>

Direct Known Subclasses:

ImmutableList, ImmutableMultiset, ImmutableSet
```
@GwtCompatible(emulated=true)
public abstract class ImmutableCollection<E>
extends AbstractCollection<E>
implements Serializable
```
An immutable collection. Does not permit null elements.
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.

Since:

2.0 (imported from Google Collections Library)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
`static class`	`ImmutableCollection.Builder<E>` Abstract base class for builders of `ImmutableCollection` types.

Method Summary

All Methods

Instance Methods

Abstract Methods

Concrete Methods

Deprecated Methods
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)`
`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()`
`<T> T[]`	`toArray(T[] other)`

Methods inherited from class java.util.AbstractCollection
containsAll, isEmpty, size, toString

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, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - iterator
```
public abstract UnmodifiableIterator<E> iterator()
```
    Returns an unmodifiable iterator across the elements in this collection.
  - toArray
```
public final Object[] toArray()
```
  - toArray
```
public final <T> T[] toArray(T[] other)
```
  - contains
```
public boolean contains(Object object)
```
  - add
```
@Deprecated
public final boolean add(E e)
```
    Deprecated. Unsupported operation.
    
    Guaranteed to throw an exception and leave the collection unmodified.
    
    Specified by:
    
    add in interface Collection<E>
    
    Overrides:
    
    add in class AbstractCollection<E>
    
    Throws:
    
    UnsupportedOperationException - always
  - remove
```
@Deprecated
public final boolean remove(Object object)
```
    Deprecated. Unsupported operation.
    
    Guaranteed to throw an exception and leave the collection unmodified.
    
    Specified by:
    
    remove in interface Collection<E>
    
    Overrides:
    
    remove in class AbstractCollection<E>
    
    Throws:
    
    UnsupportedOperationException - always
  - addAll
```
@Deprecated
public final boolean addAll(Collection<? extends E> newElements)
```
    Deprecated. Unsupported operation.
    
    Guaranteed to throw an exception and leave the collection unmodified.
    
    Specified by:
    
    addAll in interface Collection<E>
    
    Overrides:
    
    addAll in class AbstractCollection<E>
    
    Throws:
    
    UnsupportedOperationException - always
  - removeAll
```
@Deprecated
public final boolean removeAll(Collection<?> oldElements)
```
    Deprecated. Unsupported operation.
    
    Guaranteed to throw an exception and leave the collection unmodified.
    
    Specified by:
    
    removeAll in interface Collection<E>
    
    Overrides:
    
    removeAll in class AbstractCollection<E>
    
    Throws:
    
    UnsupportedOperationException - always
  - retainAll
```
@Deprecated
public final boolean retainAll(Collection<?> elementsToKeep)
```
    Deprecated. Unsupported operation.
    
    Guaranteed to throw an exception and leave the collection unmodified.
    
    Specified by:
    
    retainAll in interface Collection<E>
    
    Overrides:
    
    retainAll in class AbstractCollection<E>
    
    Throws:
    
    UnsupportedOperationException - always
  - clear
```
@Deprecated
public final void clear()
```
    Deprecated. Unsupported operation.
    
    Guaranteed to throw an exception and leave the collection unmodified.
    
    Specified by:
    
    clear in interface Collection<E>
    
    Overrides:
    
    clear in class AbstractCollection<E>
    
    Throws:
    
    UnsupportedOperationException - always
  - asList
```
public ImmutableList<E> asList()
```
    Returns a list view of the collection.
    
    Since:
    
    2.0

Class ImmutableCollection<E>

Nested Class Summary

Nested Classes

Method Summary

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Method Detail

iterator

toArray

toArray

contains

add

remove

addAll

removeAll

retainAll

clear

asList