org.apache.commons.collections.list
Class UnmodifiableList

java.lang.Object
  |
  +--org.apache.commons.collections.collection.AbstractCollectionDecorator
        |
        +--org.apache.commons.collections.list.AbstractListDecorator
              |
              +--org.apache.commons.collections.list.UnmodifiableList

All Implemented Interfaces:

Collection, List, Unmodifiable

public final class UnmodifiableList

extends AbstractListDecorator

implements Unmodifiable

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

Since:

Commons Collections 3.0

Version:

$Revision: 1.4 $ $Date: 2004/01/14 21:43:17 $

Author:

Stephen Colebourne

Field Summary

Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator

collection

Method Summary

void	add(int index, Object object)
boolean	add(Object object)
boolean	addAll(Collection coll)
boolean	addAll(int index, Collection coll)
void	clear()
static List	decorate(List list) Factory method to create an unmodifiable list.
Iterator	iterator()
ListIterator	listIterator()
ListIterator	listIterator(int index)
Object	remove(int index)
boolean	remove(Object object)
boolean	removeAll(Collection coll)
boolean	retainAll(Collection coll)
Object	set(int index, Object object)
List	subList(int fromIndex, int toIndex)

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

get, getList, indexOf, lastIndexOf

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

contains, containsAll, equals, getCollection, hashCode, isEmpty, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

contains, containsAll, equals, hashCode, isEmpty, size, toArray, toArray

Method Detail

decorate

public static List decorate(List list)

Factory method to create an unmodifiable list.

Parameters:

list - the list to decorate, must not be null

Throws:

IllegalArgumentException - if list is null

iterator

public Iterator iterator()

Specified by:

iterator in interface List

Overrides:

iterator in class AbstractCollectionDecorator

add

public boolean add(Object object)

Specified by:

add in interface List

Overrides:

add in class AbstractCollectionDecorator

addAll

public boolean addAll(Collection coll)

Specified by:

addAll in interface List

Overrides:

addAll in class AbstractCollectionDecorator

clear

public void clear()

Specified by:

clear in interface List

Overrides:

clear in class AbstractCollectionDecorator

remove

public boolean remove(Object object)

Specified by:

remove in interface List

Overrides:

remove in class AbstractCollectionDecorator

removeAll

public boolean removeAll(Collection coll)

Specified by:

removeAll in interface List

Overrides:

removeAll in class AbstractCollectionDecorator

retainAll

public boolean retainAll(Collection coll)

Specified by:

retainAll in interface List

Overrides:

retainAll in class AbstractCollectionDecorator

listIterator

public ListIterator listIterator()

Specified by:

listIterator in interface List

Overrides:

listIterator in class AbstractListDecorator

listIterator

public ListIterator listIterator(int index)

Specified by:

listIterator in interface List

Overrides:

listIterator in class AbstractListDecorator

add

public void add(int index,
                Object object)

Specified by:

add in interface List

Overrides:

add in class AbstractListDecorator

addAll

public boolean addAll(int index,
                      Collection coll)

Specified by:

addAll in interface List

Overrides:

addAll in class AbstractListDecorator

remove

public Object remove(int index)

Specified by:

remove in interface List

Overrides:

remove in class AbstractListDecorator

set

public Object set(int index,
                  Object object)

Specified by:

set in interface List

Overrides:

set in class AbstractListDecorator

subList

public List subList(int fromIndex,
                    int toIndex)

Specified by:

subList in interface List

Overrides:

subList in class AbstractListDecorator