com.google.common.collect

Class ImmutableList<E>

  • All Implemented Interfaces:
    Serializable, Iterable<E>, Collection<E>, List<E>, RandomAccess 

    @GwtCompatible(serializable=true,
               emulated=true)
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, 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.

    See the Guava User Guide article on immutable collections.

    Since:
    2.0 (imported from Google Collections Library)
    See Also:
    ImmutableMap, ImmutableSet, Serialized Form

    • 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, 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
        Since:
        3.0 (source-compatible since 2.0)

      • 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.

        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 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

      • 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.0

      • indexOf

        public int indexOf(Object object)

      • lastIndexOf

        public int lastIndexOf(Object object)

      • contains

        public boolean contains(Object object)

      • subList

        public 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.)

      • set

        @Deprecated
public final E set(int index,
                               E element)
        Deprecated.  Unsupported operation.
        Guaranteed to throw an exception and leave the list unmodified.
        Specified by:
        set in interface  List<E>
        Throws:
        UnsupportedOperationException - always

      • add

        @Deprecated
public final void add(int index,
                                  E element)
        Deprecated.  Unsupported operation.
        Guaranteed to throw an exception and leave the list unmodified.
        Specified by:
        add in interface  List<E>
        Throws:
        UnsupportedOperationException - always

      • reverse

        public ImmutableList<E> reverse()
        Returns a view of this immutable list in reverse order. For example, ImmutableList.of(1, 2, 3).reverse() is equivalent to ImmutableList.of(3, 2, 1).
        Returns:
        a view of this immutable list in reverse order
        Since:
        7.0

      • equals

        public boolean equals(Object obj)

      • hashCode

        public int hashCode()