Class ImmutableList<E>
-
- <E>
-
- com.google.common.collect.ImmutableCollection<E>
-
- com.google.common.collect.ImmutableList<E>
-
- All Implemented Interfaces:
,
<E>
,<E>
,<E>
,
@GwtCompatible(serializable=true, emulated=true) public abstract class ImmutableList<E> extends ImmutableCollection<E> implements <E>,
A whose contents will never change, with many other important properties detailed atImmutableCollection
.See the Guava User Guide article on .
- Since:
- 2.0
- Author:
- Kevin Bourrillion
- See Also:
ImmutableMap
,ImmutableSet
, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImmutableList.Builder<E>
A builder for creating immutable list instances, especiallypublic 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, <? extends E> newElements)
Deprecated.Unsupported operation.ImmutableList<E>
asList()
Returns this list instance.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
object)
Returnstrue
if this collection contains the specified element.static <E> ImmutableList<E>
copyOf(E[] elements)
Returns an immutable list containing the given elements, in order.static <E> ImmutableList<E>
<? extends E> elements)
Returns an immutable list containing the given elements, in order.static <E> ImmutableList<E>
<? extends E> elements)
Returns an immutable list containing the given elements, in order.static <E> ImmutableList<E>
<? extends E> elements)
Returns an immutable list containing the given elements, in order.boolean
obj)
Indicates whether some other object is "equal to" this one.void
<? super E> consumer)
Performs the given action for each element of theIterable
until all elements have been processed or the action throws an exception.int
hashCode()
Returns a hash code value for the object.int
object)
Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.UnmodifiableIterator<E>
iterator()
Returns an unmodifiable iterator across the elements in this collection.int
object)
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.UnmodifiableListIterator<E>
listIterator()
Returns a list iterator over the elements in this list (in proper sequence).UnmodifiableListIterator<E>
listIterator(int index)
Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.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.E
remove(int index)
Deprecated.Unsupported operation.void
<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
<? super E> c)
Deprecated.Unsupported operation.static <E extends <? super E>>
ImmutableList<E><? extends E> elements)
Returns an immutable list containing the given elements, sorted according to their natural order.static <E> ImmutableList<E>
<? super E> comparator, <? extends E> elements)
Returns an immutable list containing the given elements, in sorted order relative to the specified comparator.<E>
spliterator()
Creates a over the elements in this collection.ImmutableList<E>
subList(int fromIndex, int toIndex)
Returns an immutable list of the elements between the specifiedfromIndex
, inclusive, andtoIndex
, exclusive.static <E> <E,?,ImmutableList<E>>
toImmutableList()
Returns aCollector
that accumulates the input elements into a newImmutableList
, in encounter order.
-
-
-
Method Detail
-
toImmutableList
public static <E> <E,?,ImmutableList<E>> toImmutableList()
Returns aCollector
that accumulates the input elements into a newImmutableList
, 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 , and is preferable mainly for consistency and maintainability of your code.- Type Parameters:
E
- theList
's element type- Returns:
- an empty
List
-
of
public static <E> ImmutableList<E> of(E element)
Returns an immutable list containing a single element. This list behaves and performs comparably to , but will not accept a null element. It is preferable mainly for consistency and maintainability of your code.- Type Parameters:
E
- theList
's element type- Parameters:
element
- the single element- Returns:
- a
List
containing the specified element - Throws:
- 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.- Type Parameters:
E
- theList
's element type- Parameters:
e1
- the first elemente2
- the second element- Returns:
- a
List
containing the specified elements - Throws:
- 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.- Type Parameters:
E
- theList
's element type- Parameters:
e1
- the first elemente2
- the second elemente3
- the third element- Returns:
- a
List
containing the specified elements - Throws:
- 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.- Type Parameters:
E
- theList
's element type- Parameters:
e1
- the first elemente2
- the second elemente3
- the third elemente4
- the fourth element- Returns:
- a
List
containing the specified elements - Throws:
- 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.- Type Parameters:
E
- theList
's element type- Parameters:
e1
- the first elemente2
- the second elemente3
- the third elemente4
- the fourth elemente5
- the fifth element- Returns:
- a
List
containing the specified elements - Throws:
- 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.- Type Parameters:
E
- theList
's element type- Parameters:
e1
- the first elemente2
- the second elemente3
- the third elemente4
- the fourth elemente5
- the fifth elemente6
- the sixth element- Returns:
- a
List
containing the specified elements - Throws:
- 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.- Type Parameters:
E
- theList
's element type- Parameters:
e1
- the first elemente2
- the second elemente3
- the third elemente4
- the fourth elemente5
- the fifth elemente6
- the sixth elemente7
- the seventh element- Returns:
- a
List
containing the specified elements - Throws:
- 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.- Type Parameters:
E
- theList
's element type- Parameters:
e1
- the first elemente2
- the second elemente3
- the third elemente4
- the fourth elemente5
- the fifth elemente6
- the sixth elemente7
- the seventh elemente8
- the eighth element- Returns:
- a
List
containing the specified elements - Throws:
- 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.- Type Parameters:
E
- theList
's element type- Parameters:
e1
- the first elemente2
- the second elemente3
- the third elemente4
- the fourth elemente5
- the fifth elemente6
- the sixth elemente7
- the seventh elemente8
- the eighth elemente9
- the ninth element- Returns:
- a
List
containing the specified elements - Throws:
- 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.- Type Parameters:
E
- theList
's element type- Parameters:
e1
- the first elemente2
- the second elemente3
- the third elemente4
- the fourth elemente5
- the fifth elemente6
- the sixth elemente7
- the seventh elemente8
- the eighth elemente9
- the ninth elemente10
- the tenth element- Returns:
- a
List
containing the specified elements - Throws:
- 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:
- 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.The array
others
must not be longer thanInteger.MAX_VALUE - 12
.- Throws:
- if any element is null
- Since:
- 3.0 (source-compatible since 2.0)
-
copyOf
public static <E> <? extends E> elements)
Returns an immutable list containing the given elements, in order. Ifelements
is a , this method behaves exactly ascopyOf(Collection)
; otherwise, it behaves exactly ascopyOf(elements.iterator()
.- Throws:
- if
elements
contains a null element
-
copyOf
public static <E> <? 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 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.- Type Parameters:
E
- theList
's element type- Parameters:
elements
- aCollection
from which elements are drawn, must be non-null- Returns:
- a
List
containing the elements of the givenCollection
- Throws:
- if
elements
contains a null element
-
copyOf
public static <E> <? extends E> elements)
Returns an immutable list containing the given elements, in order.- Throws:
- 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:
- if
elements
contains a null element- Since:
- 3.0
-
sortedCopyOf
public static <E extends <? super E>> <? 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 aList
you can use itsasList()
view.Java 8 users: If you want to convert a to a sorted
ImmutableList
, usestream.sorted().collect(toImmutableList())
.- Throws:
- if any element in the input is null
- Since:
- 21.0
-
sortedCopyOf
public static <E> <? super E> comparator, <? 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 aList
you can use itsasList()
view.Java 8 users: If you want to convert a to a sorted
ImmutableList
, usestream.sorted(comparator).collect(toImmutableList())
.- Throws:
- if any element in the input is null
- Since:
- 21.0
-
iterator
public UnmodifiableIterator<E> iterator()
Description copied from class:ImmutableCollection
Returns an unmodifiable iterator across the elements in this collection.
-
listIterator
public UnmodifiableListIterator<E> listIterator()
Description copied from interface:Returns a list iterator over the elements in this list (in proper sequence).- Specified by:
in interface
<E>
- Returns:
- a list iterator over the elements in this list (in proper sequence)
-
listIterator
public UnmodifiableListIterator<E> listIterator(int index)
Description copied from interface:Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list. The specified index indicates the first element that would be returned by an initial call to . An initial call to would return the element with the specified index minus one.- Specified by:
in interface
<E>
- Parameters:
index
- index of the first element to be returned from the list iterator (by a call to )- Returns:
- a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list
-
forEach
public void <? super E> consumer)
Description copied from interface:Performs the given action for each element of theIterable
until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller.The behavior of this method is unspecified if the action performs side-effects that modify the underlying source of elements, unless an overriding class has specified a concurrent modification policy.
- Specified by:
in interface
<E>
- Parameters:
consumer
- The action to be performed for each element
-
indexOf
public int object)
Description copied from interface:Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest indexi
such thatObjects.equals(o, get(i))
, or -1 if there is no such index.- Specified by:
in interface
<E>
- Parameters:
object
- element to search for- Returns:
- the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element
-
lastIndexOf
public int object)
Description copied from interface:Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest indexi
such thatObjects.equals(o, get(i))
, or -1 if there is no such index.- Specified by:
in interface
<E>
- Parameters:
object
- element to search for- Returns:
- the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element
-
contains
public boolean object)
Description copied from class:Returnstrue
if this collection contains the specified element. More formally, returnstrue
if and only if this collection contains at least one elemente
such thatObjects.equals(o, e)
.- Specified by:
in interface
<E>
- Specified by:
in interface
<E>
- Specified by:
contains
in classImmutableCollection<E>
- Parameters:
object
- element whose presence in this collection is to be tested- Returns:
true
if this collection contains the specified element
-
subList
public ImmutableList<E> subList(int fromIndex, int toIndex)
Returns an immutable list of the elements between the specifiedfromIndex
, inclusive, andtoIndex
, exclusive. (IffromIndex
andtoIndex
are equal, the empty immutable list is returned.)- Specified by:
in interface
<E>
- Parameters:
fromIndex
- low endpoint (inclusive) of the subListtoIndex
- high endpoint (exclusive) of the subList- Returns:
- a view of the specified range within this list
-
addAll
public final boolean addAll(int index, <? extends E> newElements)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the list unmodified.- Specified by:
in interface
<E>
- Parameters:
index
- index at which to insert the first element from the specified collectionnewElements
- collection containing elements to be added to this list- Returns:
true
if this list changed as a result of the call- Throws:
- always
-
set
public final E set(int index, E element)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the list unmodified.- Specified by:
in interface
<E>
- Parameters:
index
- index of the element to replaceelement
- element to be stored at the specified position- Returns:
- the element previously at the specified position
- Throws:
- always
-
add
public final void add(int index, E element)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the list unmodified.- Specified by:
in interface
<E>
- Parameters:
index
- index at which the specified element is to be insertedelement
- element to be inserted- Throws:
- always
-
remove
public final E remove(int index)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the list unmodified.- Specified by:
in interface
<E>
- Parameters:
index
- the index of the element to be removed- Returns:
- the element previously at the specified position
- Throws:
- always
-
replaceAll
public final void <E> operator)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the list unmodified.- Specified by:
in interface
<E>
- Parameters:
operator
- the operator to apply to each element- Throws:
- always
-
sort
public final void <? super E> c)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the list unmodified.- Specified by:
in interface
<E>
- Parameters:
c
- theComparator
used to compare list elements. Anull
value indicates that the elements' should be used- Throws:
- always
-
asList
public final ImmutableList<E> asList()
Returns this list instance.- Overrides:
asList
in classImmutableCollection<E>
- Since:
- 2.0
-
spliterator
public <E> spliterator()
Description copied from interface:Creates a over the elements in this collection. Implementations should document characteristic values reported by the spliterator. Such characteristic values are not required to be reported if the spliterator reports and this collection contains no elements.The default implementation should be overridden by subclasses that can return a more efficient spliterator. In order to preserve expected laziness behavior for the and methods, spliterators should either have the characteristic of
IMMUTABLE
orCONCURRENT
, or be late-binding. If none of these is practical, the overriding class should describe the spliterator's documented policy of binding and structural interference, and should override the and methods to create streams using aSupplier
of the spliterator, as in:Stream<E> s = StreamSupport.stream(() -> spliterator(), spliteratorCharacteristics)
These requirements ensure that streams produced by the and methods will reflect the contents of the collection as of initiation of the terminal stream operation.
- Specified by:
in interface
<E>
- Specified by:
in interface
<E>
- Specified by:
in interface
<E>
- Overrides:
spliterator
in classImmutableCollection<E>
- Returns:
- a
Spliterator
over the elements in this collection
-
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 toImmutableList.of(3, 2, 1)
.- Returns:
- a view of this immutable list in reverse order
- Since:
- 7.0
-
equals
public boolean obj)
Description copied from class:Indicates whether some other object is "equal to" this one.The
equals
method implements an equivalence relation on non-null object references:- It is reflexive: for any non-null reference value
x
,x.equals(x)
should returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
The
equals
method for classObject
implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference valuesx
andy
, this method returnstrue
if and only ifx
andy
refer to the same object (x == y
has the valuetrue
).Note that it is generally necessary to override the
hashCode
method whenever this method is overridden, so as to maintain the general contract for thehashCode
method, which states that equal objects must have equal hash codes. - It is reflexive: for any non-null reference value
-
hashCode
public int hashCode()
Description copied from class:Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by .The general contract of
hashCode
is:- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals(Object)
method, then calling thehashCode
method on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
method, then calling the
hashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by class
Object
does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.) - Whenever it is invoked on the same object more than once during
an execution of a Java application, the
-
builder
public static <E> ImmutableList.Builder<E> builder()
Returns a new builder. The generated builder is equivalent to the builder created by theImmutableList.Builder
constructor.
-
builderWithExpectedSize
@Beta 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 beforeImmutableList.Builder.build()
is called, the builder is likely to perform better than an unsizedbuilder()
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
-
-