Class ImmutableList<E>

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ImmutableList.Builder<E>
      A builder for creating immutable list instances, especially public static final lists ("constant lists").
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void add​(int index, E element)
      Deprecated.
      Unsupported operation.
      boolean addAll​(int index, java.util.Collection<? extends E> newElements)
      Deprecated.
      Unsupported operation.
      ImmutableList<E> asList()
      Deprecated.
      There is no reason to use this; it always returns this.
      static <E> ImmutableList.Builder<E> builder()
      Returns a new builder.
      static <E> ImmutableList.Builder<E> builderWithExpectedSize​(int expectedSize)
      Returns a new builder, expecting the specified number of elements to be added.
      boolean contains​(java.lang.Object object)  
      static <E> ImmutableList<E> copyOf​(E[] elements)
      Returns an immutable list containing the given elements, in order.
      static <E> ImmutableList<E> copyOf​(java.lang.Iterable<? extends E> elements)
      Returns an immutable list containing the given elements, in order.
      static <E> ImmutableList<E> copyOf​(java.util.Collection<? extends E> elements)
      Returns an immutable list containing the given elements, in order.
      static <E> ImmutableList<E> copyOf​(java.util.Iterator<? extends E> elements)
      Returns an immutable list containing the given elements, in order.
      boolean equals​(java.lang.Object obj)  
      void forEach​(java.util.function.Consumer<? super E> consumer)  
      int hashCode()  
      int indexOf​(java.lang.Object object)  
      UnmodifiableIterator<E> iterator()
      Returns an unmodifiable iterator across the elements in this collection.
      int lastIndexOf​(java.lang.Object object)  
      UnmodifiableListIterator<E> listIterator()  
      UnmodifiableListIterator<E> listIterator​(int index)  
      static <E> ImmutableList<E> of()
      Returns the empty immutable list.
      static <E> ImmutableList<E> of​(E e1)
      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.
      E remove​(int index)
      Deprecated.
      Unsupported operation.
      void replaceAll​(java.util.function.UnaryOperator<E> operator)
      Deprecated.
      Unsupported operation.
      ImmutableList<E> reverse()
      Returns a view of this immutable list in reverse order.
      E set​(int index, E element)
      Deprecated.
      Unsupported operation.
      void sort​(@Nullable java.util.Comparator<? super E> c)
      Deprecated.
      Unsupported operation.
      static <E extends java.lang.Comparable<? super E>>
      ImmutableList<E>
      sortedCopyOf​(java.lang.Iterable<? extends E> elements)
      Returns an immutable list containing the given elements, sorted according to their natural order.
      static <E> ImmutableList<E> sortedCopyOf​(java.util.Comparator<? super E> comparator, java.lang.Iterable<? extends E> elements)
      Returns an immutable list containing the given elements, in sorted order relative to the specified comparator.
      java.util.Spliterator<E> spliterator()  
      ImmutableList<E> subList​(int fromIndex, int toIndex)
      Returns an immutable list of the elements between the specified fromIndex, inclusive, and toIndex, exclusive.
      static <E> java.util.stream.Collector<E,​?,​ImmutableList<E>> toImmutableList()
      Returns a Collector that accumulates the input elements into a new ImmutableList, in encounter order.
      • 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, clear, containsAll, get, isEmpty, remove, removeAll, retainAll, size, toArray, toArray
    • Method Detail

      • toImmutableList

        public static <E> java.util.stream.Collector<E,​?,​ImmutableList<E>> toImmutableList()
        Returns a Collector that accumulates the input elements into a new ImmutableList, in encounter order.
        Since:
        21.0
      • of

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

        Performance note: the instance returned is a singleton.

      • of

        public static <E> ImmutableList<E> of​(E e1)
        Returns an immutable list containing a single element. This list behaves and performs comparably to Collections.singletonList(T), but will not accept a null element. It is preferable mainly for consistency and maintainability of your code.
        Throws:
        java.lang.NullPointerException - if the 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:
        java.lang.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:
        java.lang.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:
        java.lang.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:
        java.lang.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:
        java.lang.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:
        java.lang.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:
        java.lang.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:
        java.lang.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:
        java.lang.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:
        java.lang.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.

        The array others must not be longer than Integer.MAX_VALUE - 12.

        Throws:
        java.lang.NullPointerException - if any element is null
        Since:
        3.0 (source-compatible since 2.0)
      • copyOf

        public static <E> ImmutableList<E> copyOf​(java.lang.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:
        java.lang.NullPointerException - if elements contains a null element
      • copyOf

        public static <E> ImmutableList<E> copyOf​(java.util.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:
        java.lang.NullPointerException - if elements contains a null element
      • copyOf

        public static <E> ImmutableList<E> copyOf​(java.util.Iterator<? extends E> elements)
        Returns an immutable list containing the given elements, in order.
        Throws:
        java.lang.NullPointerException - if elements contains a null element
      • copyOf

        public static <E> ImmutableList<E> copyOf​(E[] elements)
        Returns an immutable list containing the given elements, in order.
        Throws:
        java.lang.NullPointerException - if elements contains a null element
        Since:
        3.0
      • sortedCopyOf

        public static <E extends java.lang.Comparable<? super E>> ImmutableList<E> sortedCopyOf​(java.lang.Iterable<? extends E> elements)
        Returns an immutable list containing the given elements, sorted according to their natural order. The sorting algorithm used is stable, so elements that compare as equal will stay in the order in which they appear in the input.

        If your data has no duplicates, or you wish to deduplicate elements, use ImmutableSortedSet.copyOf(elements); if you want a List you can use its asList() view.

        Java 8+ users: If you want to convert a Stream to a sorted ImmutableList, use stream.sorted().collect(toImmutableList()).

        Throws:
        java.lang.NullPointerException - if any element in the input is null
        Since:
        21.0
      • sortedCopyOf

        public static <E> ImmutableList<E> sortedCopyOf​(java.util.Comparator<? super E> comparator,
                                                        java.lang.Iterable<? extends E> elements)
        Returns an immutable list containing the given elements, in sorted order relative to the specified comparator. The sorting algorithm used is stable, so elements that compare as equal will stay in the order in which they appear in the input.

        If your data has no duplicates, or you wish to deduplicate elements, use ImmutableSortedSet.copyOf(comparator, elements); if you want a List you can use its asList() view.

        Java 8+ users: If you want to convert a Stream to a sorted ImmutableList, use stream.sorted(comparator).collect(toImmutableList()).

        Throws:
        java.lang.NullPointerException - if any element in the input is null
        Since:
        21.0
      • iterator

        public UnmodifiableIterator<Eiterator()
        Description copied from class: ImmutableCollection
        Returns an unmodifiable iterator across the elements in this collection.
        Specified by:
        iterator in interface java.util.Collection<E>
        Specified by:
        iterator in interface java.lang.Iterable<E>
        Specified by:
        iterator in interface java.util.List<E>
        Specified by:
        iterator in class ImmutableCollection<E>
      • forEach

        public void forEach​(java.util.function.Consumer<? super E> consumer)
        Specified by:
        forEach in interface java.lang.Iterable<E>
      • indexOf

        public int indexOf​(@CheckForNull
                           java.lang.Object object)
        Specified by:
        indexOf in interface java.util.List<E>
      • lastIndexOf

        public int lastIndexOf​(@CheckForNull
                               java.lang.Object object)
        Specified by:
        lastIndexOf in interface java.util.List<E>
      • subList

        public ImmutableList<EsubList​(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.)

        Note: in almost all circumstances, the returned ImmutableList retains a strong reference to this, which may prevent the original list from being garbage collected. If you want the original list to be eligible for garbage collection, you should create and use a copy of the sub list (e.g., ImmutableList.copyOf(originalList.subList(...))).

        Specified by:
        subList in interface java.util.List<E>
      • addAll

        @CanIgnoreReturnValue
        @Deprecated
        public final boolean addAll​(int index,
                                    java.util.Collection<? extends E> newElements)
        Deprecated.
        Unsupported operation.
        Guaranteed to throw an exception and leave the list unmodified.
        Specified by:
        addAll in interface java.util.List<E>
        Throws:
        java.lang.UnsupportedOperationException - always
      • set

        @CanIgnoreReturnValue
        @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 java.util.List<E>
        Throws:
        java.lang.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 java.util.List<E>
        Throws:
        java.lang.UnsupportedOperationException - always
      • remove

        @CanIgnoreReturnValue
        @Deprecated
        public final E remove​(int index)
        Deprecated.
        Unsupported operation.
        Guaranteed to throw an exception and leave the list unmodified.
        Specified by:
        remove in interface java.util.List<E>
        Throws:
        java.lang.UnsupportedOperationException - always
      • replaceAll

        @Deprecated
        public final void replaceAll​(java.util.function.UnaryOperator<E> operator)
        Deprecated.
        Unsupported operation.
        Guaranteed to throw an exception and leave the list unmodified.
        Specified by:
        replaceAll in interface java.util.List<E>
        Throws:
        java.lang.UnsupportedOperationException - always
      • sort

        @Deprecated
        public final void sort​(@Nullable java.util.Comparator<? super E> c)
        Deprecated.
        Unsupported operation.
        Guaranteed to throw an exception and leave the list unmodified.
        Specified by:
        sort in interface java.util.List<E>
        Throws:
        java.lang.UnsupportedOperationException - always
      • spliterator

        public java.util.Spliterator<Espliterator()
        Specified by:
        spliterator in interface java.util.Collection<E>
        Specified by:
        spliterator in interface java.lang.Iterable<E>
        Specified by:
        spliterator in interface java.util.List<E>
        Overrides:
        spliterator in class ImmutableCollection<E>
      • reverse

        public ImmutableList<Ereverse()
        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​(@CheckForNull
                              java.lang.Object obj)
        Specified by:
        equals in interface java.util.Collection<E>
        Specified by:
        equals in interface java.util.List<E>
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface java.util.Collection<E>
        Specified by:
        hashCode in interface java.util.List<E>
        Overrides:
        hashCode in class java.lang.Object
      • builderWithExpectedSize

        public static <E> ImmutableList.Builder<E> builderWithExpectedSize​(int expectedSize)
        Returns a new builder, expecting the specified number of elements to be added.

        If expectedSize is exactly the number of elements added to the builder before ImmutableList.Builder.build() is called, the builder is likely to perform better than an unsized builder() would have.

        It is not specified if any performance benefits apply if expectedSize is close to, but not exactly, the number of elements added to the builder.

        Since:
        23.1