Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.google.common.collect
Class ImmutableList<E>

java.lang.Object
  extended by com.google.common.collect.ImmutableCollection<E>
      extended by com.google.common.collect.ImmutableList<E>
All Implemented Interfaces:
Serializable, Iterable<E>, Collection<E>, List<E>, RandomAccess
public abstract class ImmutableList<E>
extends ImmutableCollection<E>
implements List<E>, RandomAccess

A high-performance, immutable, random-access List implementation. Does not permit null elements.

Unlike Collections.unmodifiableList(java.util.List), which is a view of a separate collection that can still change, an instance of ImmutableList contains its own private data and will never change. ImmutableList is convenient for public static final lists ("constant lists") and also lets you easily make a "defensive copy" of a list provided to your class by a caller.

Note: Although this class is not final, it cannot be subclassed as it has no public or protected constructors. Thus, instances of this type are guaranteed to be immutable.

Since:
2 (imported from Google Collections Library)
Author:
Kevin Bourrillion
See Also:
ImmutableMap, ImmutableSet, Serialized Form

Nested Class Summary
static class ImmutableList.Builder<E>
          A builder for creating immutable list instances, especially public static final lists ("constant lists").
 
Method Summary
 void add(int index, E element)
          Guaranteed to throw an exception and leave the list unmodified.
 boolean addAll(int index, Collection<? extends E> newElements)
          Guaranteed to throw an exception and leave the list unmodified.
 ImmutableList<E> asList()
          Returns this list instance.
static
<E> ImmutableList.Builder<E>
builder()
          Returns a new builder.
static
<E> ImmutableList<E>
copyOf(Collection<? extends E> elements)
          Returns an immutable list containing the given elements, in order.
static
<E> ImmutableList<E>
copyOf(E[] elements)
          Returns an immutable list containing the given elements, in order.
static
<E> ImmutableList<E>
copyOf(Iterable<? extends E> elements)
          Returns an immutable list containing the given elements, in order.
static
<E> ImmutableList<E>
copyOf(Iterator<? extends E> elements)
          Returns an immutable list containing the given elements, in order.
abstract  int indexOf(Object object)
           
abstract  UnmodifiableIterator<E> iterator()
          Returns an unmodifiable iterator across the elements in this collection.
abstract  int lastIndexOf(Object object)
           
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[] elements)
          Deprecated. use copyOf(Object[])
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.
 E remove(int index)
          Guaranteed to throw an exception and leave the list unmodified.
 E set(int index, E element)
          Guaranteed to throw an exception and leave the list unmodified.
abstract  ImmutableList<E> subList(int fromIndex, int toIndex)
          Returns an immutable list of the elements between the specified fromIndex, inclusive, and toIndex, exclusive.
 
Methods inherited from class com.google.common.collect.ImmutableCollection
add, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
add, addAll, clear, contains, containsAll, equals, get, hashCode, isEmpty, listIterator, listIterator, remove, removeAll, retainAll, size, toArray, toArray
 

Method Detail

of

public static <E> ImmutableList<E> of()
Returns the empty immutable list. This set behaves and performs comparably to Collections.emptyList(), and is preferable mainly for consistency and maintainability of your code.

of

public static <E> ImmutableList<E> of(E element)
Returns an immutable list containing a single element. This list behaves and performs comparably to Collections.singleton(T), but will not accept a null element. It is preferable mainly for consistency and maintainability of your code.

Throws:
NullPointerException - if element is null

of

public static <E> ImmutableList<E> of(E e1,
                                      E e2)
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)
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)
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)
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)
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)
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)
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)
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)
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

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

of

@Deprecated
public static <E> ImmutableList<E> of(E[] elements)
Deprecated. use copyOf(Object[])

Returns an immutable list containing the given elements, in order.

Throws:
NullPointerException - if any of elements is null

copyOf

public static <E> ImmutableList<E> copyOf(Iterable<? extends E> elements)
Returns an immutable list containing the given elements, in order. If elements is a Collection, this method behaves exactly as copyOf(Collection); otherwise, it behaves exactly as copyOf(elements.iterator().

Throws:
NullPointerException - if any of elements is null

copyOf

public static <E> ImmutableList<E> copyOf(Collection<? extends E> elements)
Returns an immutable list containing the given elements, in order.

Note: Despite what the method name suggests, if elements is an ImmutableList, no copy will actually be performed, and the given list itself will be returned.

Note that if list is a List<String>, then ImmutableList.copyOf(list) returns an ImmutableList<String> containing each of the strings in list, while ImmutableList.of(list)} returns an ImmutableList<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 of elements is null
Since:
2 (Iterable overload existed previously)

copyOf

public static <E> ImmutableList<E> copyOf(Iterator<? extends E> elements)
Returns an immutable list containing the given elements, in order.

Throws:
NullPointerException - if any of elements is null

copyOf

public static <E> ImmutableList<E> copyOf(E[] elements)
Returns an immutable list containing the given elements, in order.

Throws:
NullPointerException - if any of elements is null
Since:
3

iterator

public abstract UnmodifiableIterator<E> iterator()
Description copied from class: ImmutableCollection
Returns an unmodifiable iterator across the elements in this collection.

Specified by:
iterator in interface Iterable<E>
Specified by:
iterator in interface Collection<E>
Specified by:
iterator in interface List<E>
Specified by:
iterator in class ImmutableCollection<E>

indexOf

public abstract int indexOf(@Nullable
                            Object object)
Specified by:
indexOf in interface List<E>

lastIndexOf

public abstract int lastIndexOf(@Nullable
                                Object object)
Specified by:
lastIndexOf in interface List<E>

subList

public abstract ImmutableList<E> subList(int fromIndex,
                                         int toIndex)
Returns an immutable list of the elements between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the empty immutable list is returned.)

Specified by:
subList in interface List<E>

addAll

public final boolean addAll(int index,
                            Collection<? extends E> newElements)
Guaranteed to throw an exception and leave the list unmodified.

Specified by:
addAll in interface List<E>
Throws:
UnsupportedOperationException - always

set

public final E set(int index,
                   E element)
Guaranteed to throw an exception and leave the list unmodified.

Specified by:
set in interface List<E>
Throws:
UnsupportedOperationException - always

add

public final void add(int index,
                      E element)
Guaranteed to throw an exception and leave the list unmodified.

Specified by:
add in interface List<E>
Throws:
UnsupportedOperationException - always

remove

public final E remove(int index)
Guaranteed to throw an exception and leave the list unmodified.

Specified by:
remove in interface List<E>
Throws:
UnsupportedOperationException - always

asList

public ImmutableList<E> asList()
Returns this list instance.

Overrides:
asList in class ImmutableCollection<E>
Since:
2

builder

public static <E> ImmutableList.Builder<E> builder()
Returns a new builder. The generated builder is equivalent to the builder created by the ImmutableList.Builder constructor.

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD