org.apache.commons.collections.list

Class SynchronizedList

public class SynchronizedList extends SynchronizedCollection implements List

Decorates another List to synchronize its behaviour for a multi-threaded environment.

Methods are synchronized, then forwarded to the decorated list.

This class is Serializable from Commons Collections 3.1.

Since: Commons Collections 3.0

Version: $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $

Author: Stephen Colebourne

Constructor Summary
protected SynchronizedList(List list)
Constructor that wraps (not copies).
protected SynchronizedList(List list, Object lock)
Constructor that wraps (not copies).
Method Summary
voidadd(int index, Object object)
booleanaddAll(int index, Collection coll)
static Listdecorate(List list)
Factory method to create a synchronized list.
Objectget(int index)
protected ListgetList()
Gets the decorated list.
intindexOf(Object object)
intlastIndexOf(Object object)
ListIteratorlistIterator()
Iterators must be manually synchronized.
ListIteratorlistIterator(int index)
Iterators must be manually synchronized.
Objectremove(int index)
Objectset(int index, Object object)
ListsubList(int fromIndex, int toIndex)

Constructor Detail

SynchronizedList

protected SynchronizedList(List list)
Constructor that wraps (not copies).

Parameters: list the list to decorate, must not be null

Throws: IllegalArgumentException if list is null

SynchronizedList

protected SynchronizedList(List list, Object lock)
Constructor that wraps (not copies).

Parameters: list the list to decorate, must not be null lock the lock to use, must not be null

Throws: IllegalArgumentException if list is null

Method Detail

add

public void add(int index, Object object)

addAll

public boolean addAll(int index, Collection coll)

decorate

public static List decorate(List list)
Factory method to create a synchronized list.

Parameters: list the list to decorate, must not be null

Throws: IllegalArgumentException if list is null

get

public Object get(int index)

getList

protected List getList()
Gets the decorated list.

Returns: the decorated list

indexOf

public int indexOf(Object object)

lastIndexOf

public int lastIndexOf(Object object)

listIterator

public ListIterator listIterator()
Iterators must be manually synchronized.
 synchronized (coll) {
   ListIterator it = coll.listIterator();
   // do stuff with iterator
 }

Returns: an iterator that must be manually synchronized on the collection

listIterator

public ListIterator listIterator(int index)
Iterators must be manually synchronized.
 synchronized (coll) {
   ListIterator it = coll.listIterator(3);
   // do stuff with iterator
 }

Returns: an iterator that must be manually synchronized on the collection

remove

public Object remove(int index)

set

public Object set(int index, Object object)

subList

public List subList(int fromIndex, int toIndex)
Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.