Package com.google.common.collect
Class ImmutableList<E>
java.lang.Object
java.util.AbstractCollection<E>
com.google.common.collect.ImmutableCollection<E>
com.google.common.collect.ImmutableList<E>
- All Implemented Interfaces:
Serializable
,Iterable<E>
,Collection<E>
,List<E>
,RandomAccess
,SequencedCollection<E>
@GwtCompatible(serializable=true,
emulated=true)
public abstract class ImmutableList<E>
extends ImmutableCollection<E>
implements List<E>, RandomAccess
A
List
whose contents will never change, with many other important properties detailed at
ImmutableCollection
.
See the Guava User Guide article on immutable collections.
- Since:
- 2.0
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A builder for creating immutable list instances, especiallypublic static final
lists ("constant lists"). -
Method Summary
Modifier and TypeMethodDescriptionfinal void
Deprecated.Unsupported operation.final boolean
addAll
(int index, Collection<? extends E> newElements) Deprecated.Unsupported operation.final ImmutableList
<E> asList()
Returns this list instance.static <E> ImmutableList.Builder
<E> builder()
Returns a new builder.boolean
static <E> ImmutableList
<E> copyOf
(E[] elements) Returns an immutable list containing the given elements, in order.static <E> ImmutableList
<E> Returns an immutable list containing the given elements, in order.static <E> ImmutableList
<E> copyOf
(Collection<? extends E> elements) Returns an immutable list containing the given elements, in order.static <E> ImmutableList
<E> Returns an immutable list containing the given elements, in order.boolean
int
hashCode()
int
iterator()
Returns an unmodifiable iterator across the elements in this collection.int
lastIndexOf
(Object object) listIterator
(int index) static <E> ImmutableList
<E> of()
Returns the empty immutable list.static <E> ImmutableList
<E> of
(E element) Returns an immutable list containing a single element.static <E> ImmutableList
<E> of
(E e1, E e2) Returns an immutable list containing the given elements, in order.static <E> ImmutableList
<E> of
(E e1, E e2, E e3) Returns an immutable list containing the given elements, in order.static <E> ImmutableList
<E> of
(E e1, E e2, E e3, E e4) Returns an immutable list containing the given elements, in order.static <E> ImmutableList
<E> of
(E e1, E e2, E e3, E e4, E e5) Returns an immutable list containing the given elements, in order.static <E> ImmutableList
<E> of
(E e1, E e2, E e3, E e4, E e5, E e6) Returns an immutable list containing the given elements, in order.static <E> ImmutableList
<E> of
(E e1, E e2, E e3, E e4, E e5, E e6, E e7) Returns an immutable list containing the given elements, in order.static <E> ImmutableList
<E> of
(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8) Returns an immutable list containing the given elements, in order.static <E> ImmutableList
<E> of
(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8, E e9) Returns an immutable list containing the given elements, in order.static <E> ImmutableList
<E> of
(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8, E e9, E e10) Returns an immutable list containing the given elements, in order.static <E> ImmutableList
<E> of
(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8, E e9, E e10, E e11) Returns an immutable list containing the given elements, in order.static <E> ImmutableList
<E> of
(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8, E e9, E e10, E e11, E e12, E... others) Returns an immutable list containing the given elements, in order.final E
remove
(int index) Deprecated.Unsupported operation.reverse()
Returns a view of this immutable list in reverse order.final E
Deprecated.Unsupported operation.subList
(int fromIndex, int toIndex) Returns an immutable list of the elements between the specifiedfromIndex
, inclusive, andtoIndex
, exclusive.Methods inherited from class com.google.common.collect.ImmutableCollection
add, addAll, clear, remove, removeAll, retainAll, toArray, toArray
Methods inherited from class java.util.AbstractCollection
containsAll, isEmpty, size, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray
Methods inherited from interface java.util.List
add, addAll, addFirst, addLast, clear, containsAll, get, getFirst, getLast, isEmpty, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, size, sort, spliterator, toArray, toArray
-
Method Details
-
of
Returns the empty immutable list. This list behaves and performs comparably toCollections.emptyList()
, and is preferable mainly for consistency and maintainability of your code. -
of
Returns an immutable list containing a single element. This list behaves and performs comparably toCollections.singleton(T)
, but will not accept a null element. It is preferable mainly for consistency and maintainability of your code.- Throws:
NullPointerException
- ifelement
is null
-
of
Returns an immutable list containing the given elements, in order.- Throws:
NullPointerException
- if any element is null
-
of
Returns an immutable list containing the given elements, in order.- Throws:
NullPointerException
- if any element is null
-
of
Returns an immutable list containing the given elements, in order.- Throws:
NullPointerException
- if any element is null
-
of
Returns an immutable list containing the given elements, in order.- Throws:
NullPointerException
- if any element is null
-
of
Returns an immutable list containing the given elements, in order.- Throws:
NullPointerException
- if any element is null
-
of
Returns an immutable list containing the given elements, in order.- Throws:
NullPointerException
- if any element is null
-
of
Returns an immutable list containing the given elements, in order.- Throws:
NullPointerException
- if any element is null
-
of
Returns an immutable list containing the given elements, in order.- Throws:
NullPointerException
- if any element is null
-
of
Returns an immutable list containing the given elements, in order.- Throws:
NullPointerException
- if any element is null
-
of
public static <E> ImmutableList<E> of(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8, E e9, E e10, E e11) Returns an immutable list containing the given elements, in order.- Throws:
NullPointerException
- if any element is null
-
of
@SafeVarargs public static <E> ImmutableList<E> of(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8, E e9, E e10, E e11, E e12, E... others) Returns an immutable list containing the given elements, in order.- Throws:
NullPointerException
- if any element is null- Since:
- 3.0 (source-compatible since 2.0)
-
copyOf
Returns an immutable list containing the given elements, in order. Ifelements
is aCollection
, this method behaves exactly ascopyOf(Collection)
; otherwise, it behaves exactly ascopyOf(elements.iterator()
.- Throws:
NullPointerException
- if any ofelements
is null
-
copyOf
Returns an immutable list containing the given elements, in order.Despite the method name, this method attempts to avoid actually copying the data when it is safe to do so. The exact circumstances under which a copy will or will not be performed are undocumented and subject to change.
Note that if
list
is aList<String>
, thenImmutableList.copyOf(list)
returns anImmutableList<String>
containing each of the strings inlist
, while ImmutableList.of(list)} returns anImmutableList<List<String>>
containing one element (the given list itself).This method is safe to use even when
elements
is a synchronized or concurrent collection that is currently being modified by another thread.- Throws:
NullPointerException
- if any ofelements
is null
-
copyOf
Returns an immutable list containing the given elements, in order.- Throws:
NullPointerException
- if any ofelements
is null
-
copyOf
Returns an immutable list containing the given elements, in order.- Throws:
NullPointerException
- if any ofelements
is null- Since:
- 3.0
-
iterator
Description copied from class:ImmutableCollection
Returns an unmodifiable iterator across the elements in this collection. -
listIterator
- Specified by:
listIterator
in interfaceList<E>
-
listIterator
- Specified by:
listIterator
in interfaceList<E>
-
indexOf
-
lastIndexOf
- Specified by:
lastIndexOf
in interfaceList<E>
-
contains
- Specified by:
contains
in interfaceCollection<E>
- Specified by:
contains
in interfaceList<E>
- Specified by:
contains
in classImmutableCollection<E>
-
subList
Returns an immutable list of the elements between the specifiedfromIndex
, inclusive, andtoIndex
, exclusive. (IffromIndex
andtoIndex
are equal, the empty immutable list is returned.) -
addAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the list unmodified.- Specified by:
addAll
in interfaceList<E>
- Throws:
UnsupportedOperationException
- always
-
set
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the list unmodified.- Specified by:
set
in interfaceList<E>
- Throws:
UnsupportedOperationException
- always
-
add
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the list unmodified.- Specified by:
add
in interfaceList<E>
- Throws:
UnsupportedOperationException
- always
-
remove
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the list unmodified.- Specified by:
remove
in interfaceList<E>
- Throws:
UnsupportedOperationException
- always
-
asList
Returns this list instance.- Overrides:
asList
in classImmutableCollection<E>
- Since:
- 2.0
-
reverse
Returns a view of this immutable list in reverse order. For example,ImmutableList.of(1, 2, 3).reverse()
is equivalent toImmutableList.of(3, 2, 1)
.- Returns:
- a view of this immutable list in reverse order
- Since:
- 7.0
-
equals
-
hashCode
public int hashCode() -
builder
Returns a new builder. The generated builder is equivalent to the builder created by theImmutableList.Builder
constructor.
-