|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.google.common.collect.ImmutableCollection<E>
com.google.common.collect.ImmutableList<E>
public abstract class ImmutableList<E>
A high-performance, immutable, random-access List implementation.
Does not permit null elements.
Unlike Collections.unmodifiableList(java.util.List extends T>), 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.
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. |
|
static
|
builder()
Returns a new builder. |
|
static
|
copyOf(Iterable<? extends E> elements)
Returns an immutable list containing the given elements, in order. |
|
static
|
copyOf(Iterator<? extends E> elements)
Returns an immutable list containing the given elements, in order. |
|
abstract int |
indexOf(Object 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. |
|
abstract UnmodifiableIterator<E> |
iterator()
Returns an unmodifiable iterator across the elements in this collection. |
|
abstract int |
lastIndexOf(Object 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. |
|
static
|
of()
Returns the empty immutable list. |
|
static
|
of(E... elements)
Returns an immutable list containing the given elements, in order. |
|
static
|
of(E element)
Returns an immutable list containing a single element. |
|
static
|
of(E e1,
E e2)
Identical to of(Object[]). |
|
static
|
of(E e1,
E e2,
E e3)
Identical to of(Object[]). |
|
static
|
of(E e1,
E e2,
E e3,
E e4)
Identical to of(Object[]). |
|
static
|
of(E e1,
E e2,
E e3,
E e4,
E e5)
Identical to of(Object[]). |
|
static
|
of(E e1,
E e2,
E e3,
E e4,
E e5,
E e6)
Identical to of(Object[]). |
|
static
|
of(E e1,
E e2,
E e3,
E e4,
E e5,
E e6,
E e7)
Identical to of(Object[]). |
|
static
|
of(E e1,
E e2,
E e3,
E e4,
E e5,
E e6,
E e7,
E e8)
Identical to of(Object[]). |
|
static
|
of(E e1,
E e2,
E e3,
E e4,
E e5,
E e6,
E e7,
E e8,
E e9)
Identical to of(Object[]). |
|
static
|
of(E e1,
E e2,
E e3,
E e4,
E e5,
E e6,
E e7,
E e8,
E e9,
E e10)
Identical to of(Object[]). |
|
static
|
of(E e1,
E e2,
E e3,
E e4,
E e5,
E e6,
E e7,
E e8,
E e9,
E e10,
E e11)
Identical to of(Object[]). |
|
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 |
|---|
public static <E> ImmutableList<E> of()
Collections.emptyList(), and is preferable mainly for consistency
and maintainability of your code.
public static <E> ImmutableList<E> of(E element)
Collections.singleton(T), but will not
accept a null element. It is preferable mainly for consistency and
maintainability of your code.
NullPointerException - if element is null
public static <E> ImmutableList<E> of(E e1,
E e2)
of(Object[]).
NullPointerException - if any element is null
public static <E> ImmutableList<E> of(E e1,
E e2,
E e3)
of(Object[]).
NullPointerException - if any element is null
public static <E> ImmutableList<E> of(E e1,
E e2,
E e3,
E e4)
of(Object[]).
NullPointerException - if any element is null
public static <E> ImmutableList<E> of(E e1,
E e2,
E e3,
E e4,
E e5)
of(Object[]).
NullPointerException - if any element is null
public static <E> ImmutableList<E> of(E e1,
E e2,
E e3,
E e4,
E e5,
E e6)
of(Object[]).
NullPointerException - if any element is null
public static <E> ImmutableList<E> of(E e1,
E e2,
E e3,
E e4,
E e5,
E e6,
E e7)
of(Object[]).
NullPointerException - if any element is null
public static <E> ImmutableList<E> of(E e1,
E e2,
E e3,
E e4,
E e5,
E e6,
E e7,
E e8)
of(Object[]).
NullPointerException - if any element is null
public static <E> ImmutableList<E> of(E e1,
E e2,
E e3,
E e4,
E e5,
E e6,
E e7,
E e8,
E e9)
of(Object[]).
NullPointerException - if any element is null
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)
of(Object[]).
NullPointerException - if any element is null
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)
of(Object[]).
NullPointerException - if any element is nullpublic static <E> ImmutableList<E> of(E... elements)
NullPointerException - if any of elements is nullpublic static <E> ImmutableList<E> copyOf(Iterable<? extends E> elements)
elements at most once. 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.
NullPointerException - if any of elements is nullpublic static <E> ImmutableList<E> copyOf(Iterator<? extends E> elements)
NullPointerException - if any of elements is nullpublic abstract UnmodifiableIterator<E> iterator()
ImmutableCollection
iterator in interface Iterable<E>iterator in interface Collection<E>iterator in interface List<E>iterator in class ImmutableCollection<E>
public abstract int indexOf(@Nullable
Object object)
java.util.List
indexOf in interface List<E>object - element to search for
public abstract int lastIndexOf(@Nullable
Object object)
java.util.List
lastIndexOf in interface List<E>object - element to search for
public abstract ImmutableList<E> subList(int fromIndex,
int toIndex)
fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the empty immutable list is
returned.)
subList in interface List<E>fromIndex - low endpoint (inclusive) of the subListtoIndex - high endpoint (exclusive) of the subList
public final boolean addAll(int index,
Collection<? extends E> newElements)
addAll in interface List<E>index - index at which to insert the first element from the
specified collectionnewElements - collection containing elements to be added to this list
UnsupportedOperationException - always
public final E set(int index,
E element)
set in interface List<E>index - index of the element to replaceelement - element to be stored at the specified position
UnsupportedOperationException - always
public final void add(int index,
E element)
add in interface List<E>index - index at which the specified element is to be insertedelement - element to be inserted
UnsupportedOperationException - alwayspublic final E remove(int index)
remove in interface List<E>index - the index of the element to be removed
UnsupportedOperationException - alwayspublic static <E> ImmutableList.Builder<E> builder()
ImmutableList.Builder constructor.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||