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

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList<E>
          extended by com.google.common.collect.ImmutableList<E>
All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, java.util.RandomAccess

public abstract class ImmutableList<E>
extends java.util.AbstractList<E>
implements java.util.RandomAccess, java.io.Serializable

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, the immutability guarantee can be trusted.

Author:
Kevin Bourrillion
See Also:
ImmutableSet, Serialized Form

Field Summary
 
Fields inherited from class java.util.AbstractList
modCount
 
Method Summary
 boolean contains(java.lang.Object object)
           
static
<E> ImmutableList<E>
copyOf(java.lang.Iterable<? extends E> elements)
          Returns an immutable list containing the given elements, in order.
 int indexOf(java.lang.Object object)
           
 int lastIndexOf(java.lang.Object object)
           
static
<E> ImmutableList<E>
of()
          Returns the empty immutable list.
static
<E> ImmutableList<E>
of(E... elements)
          Returns an immutable list containing the given elements, in order.
static
<E> ImmutableList<E>
of(E element)
          Returns an immutable list containing a single element.
 
Methods inherited from class java.util.AbstractList
add, add, addAll, clear, equals, get, hashCode, iterator, listIterator, listIterator, remove, removeRange, set, subList
 
Methods inherited from class java.util.AbstractCollection
addAll, containsAll, isEmpty, remove, removeAll, retainAll, size, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
addAll, containsAll, isEmpty, 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.


of

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

Throws:
java.lang.NullPointerException - if any of elements is null

copyOf

public static <E> ImmutableList<E> copyOf(java.lang.Iterable<? extends E> elements)
Returns an immutable list containing the given elements, in order. 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).

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.

Throws:
java.lang.NullPointerException - if any of elements are null

indexOf

public int indexOf(@Nullable
                   java.lang.Object object)
Specified by:
indexOf in interface java.util.List<E>
Overrides:
indexOf in class java.util.AbstractList<E>

lastIndexOf

public int lastIndexOf(@Nullable
                       java.lang.Object object)
Specified by:
lastIndexOf in interface java.util.List<E>
Overrides:
lastIndexOf in class java.util.AbstractList<E>

contains

public boolean contains(@Nullable
                        java.lang.Object object)
Specified by:
contains in interface java.util.Collection<E>
Specified by:
contains in interface java.util.List<E>
Overrides:
contains in class java.util.AbstractCollection<E>


Copyright © 2008 Google. All Rights Reserved.