Package org.apache.commons.collections4.list

Class UnmodifiableList<E>

java.lang.Object

org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>

org.apache.commons.collections4.list.AbstractListDecorator<E>

org.apache.commons.collections4.list.AbstractSerializableListDecorator<E>

org.apache.commons.collections4.list.UnmodifiableList<E>

All Implemented Interfaces:

Unmodifiable

public final class UnmodifiableList<E>
extends AbstractSerializableListDecorator<E>
implements Unmodifiable

Decorates another List to ensure it can't be altered.

This class is Serializable from Commons Collections 3.1.

Attempts to modify it will result in an UnsupportedOperationException.

Since:

3.0

Version:

$Id: UnmodifiableList.java 1686855 2015-06-22 13:00:27Z tn $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UnmodifiableList(java.util.List<? extends E> list)	Constructor that wraps (not copies).

Method Summary

Modifier and Type	Method	Description
void	add(int index, E object)
boolean	add(java.lang.Object object)
boolean	addAll(int index, java.util.Collection<? extends E> coll)
boolean	addAll(java.util.Collection<? extends E> coll)
void	clear()
java.util.Iterator<E>	iterator()
java.util.ListIterator<E>	listIterator()
java.util.ListIterator<E>	listIterator(int index)
E	remove(int index)
boolean	remove(java.lang.Object object)
boolean	removeAll(java.util.Collection<?> coll)
boolean	retainAll(java.util.Collection<?> coll)
E	set(int index, E object)
java.util.List<E>	subList(int fromIndex, int toIndex)
static <E> java.util.List<E>	unmodifiableList(java.util.List<? extends E> list)	Factory method to create an unmodifiable list.

Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator

contains, containsAll, isEmpty, setCollection, size, toArray, toArray, toString

Methods inherited from class org.apache.commons.collections4.list.AbstractListDecorator

decorated, equals, get, hashCode, indexOf, lastIndexOf

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

contains, containsAll, isEmpty, of, of, of, of, of, of, of, of, of, of, of, of, replaceAll, size, sort, spliterator, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UnmodifiableList

public UnmodifiableList(java.util.List<? extends E> list)

Constructor that wraps (not copies).

Parameters:

list - the list to decorate, must not be null

Throws:

java.lang.NullPointerException - if list is null

Method Detail

unmodifiableList

public static <E> java.util.List<E> unmodifiableList(java.util.List<? extends E> list)

Factory method to create an unmodifiable list.

Type Parameters:

E - the type of the elements in the list

Parameters:

list - the list to decorate, must not be null

Returns:

a new unmodifiable list

Throws:

java.lang.NullPointerException - if list is null

Since:

4.0

iterator

public java.util.Iterator<E> iterator()

Overrides:

iterator in class AbstractCollectionDecorator<E>

add

public boolean add(java.lang.Object object)

Overrides:

add in class AbstractCollectionDecorator<E>

addAll

public boolean addAll(java.util.Collection<? extends E> coll)

Overrides:

addAll in class AbstractCollectionDecorator<E>

clear

public void clear()

Overrides:

clear in class AbstractCollectionDecorator<E>

remove

public boolean remove(java.lang.Object object)

Overrides:

remove in class AbstractCollectionDecorator<E>

removeAll

public boolean removeAll(java.util.Collection<?> coll)

Overrides:

removeAll in class AbstractCollectionDecorator<E>

retainAll

public boolean retainAll(java.util.Collection<?> coll)

Overrides:

retainAll in class AbstractCollectionDecorator<E>

listIterator

public java.util.ListIterator<E> listIterator()

Overrides:

listIterator in class AbstractListDecorator<E>

listIterator

public java.util.ListIterator<E> listIterator(int index)

Overrides:

listIterator in class AbstractListDecorator<E>

add

public void add(int index,
                E object)

Overrides:

add in class AbstractListDecorator<E>

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends E> coll)

Overrides:

addAll in class AbstractListDecorator<E>

remove

public E remove(int index)

Overrides:

remove in class AbstractListDecorator<E>

set

public E set(int index,
             E object)

Overrides:

set in class AbstractListDecorator<E>

subList

public java.util.List<E> subList(int fromIndex,
                                 int toIndex)

Overrides:

subList in class AbstractListDecorator<E>