org.springframework.util
Class AutoPopulatingList

java.lang.Object
  org.springframework.util.AutoPopulatingList

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable, java.util.Collection, java.util.List

public class AutoPopulatingList
extends java.lang.Object
implements java.util.List, java.io.Serializable

Simple List wrapper class that allows for elements to be automatically populated as they are requested. This is particularly useful for data binding to Lists, allowing for elements to be created and added to the List in a "just in time" fashion.

Note: This class is not thread-safe. To create a thread-safe version, use the Collections.synchronizedList(java.util.List) utility methods.

Inspired by LazyList from Commons Collections.

Since:

2.0

Author:

Rob Harrop, Juergen Hoeller

See Also:

Serialized Form

Nested Class Summary

static interface	AutoPopulatingList.ElementFactory Factory interface for creating elements for an index-based access data structure such as a List.
static class	AutoPopulatingList.ElementInstantiationException Exception to be thrown from ElementFactory.

Constructor Summary

AutoPopulatingList(AutoPopulatingList.ElementFactory elementFactory)
Creates a new AutoPopulatingList that is backed by a standard ArrayList and creates new elements on demand using the supplied AutoPopulatingList.ElementFactory.

AutoPopulatingList(java.lang.Class elementClass)
Creates a new AutoPopulatingList that is backed by a standard ArrayList and adds new instances of the supplied element Class to the backing List on demand.

AutoPopulatingList(java.util.List backingList, AutoPopulatingList.ElementFactory elementFactory)
Creates a new AutoPopulatingList that is backed by the supplied List and creates new elements on demand using the supplied AutoPopulatingList.ElementFactory.

AutoPopulatingList(java.util.List backingList, java.lang.Class elementClass)
Creates a new AutoPopulatingList that is backed by the supplied List and adds new instances of the supplied element Class to the backing List on demand.

Method Summary

void	add(int index, java.lang.Object element)
boolean	add(java.lang.Object o)
boolean	addAll(java.util.Collection c)
boolean	addAll(int index, java.util.Collection c)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection c)
boolean	equals(java.lang.Object o)
java.lang.Object	get(int index) Get the element at the supplied index, creating it if there is no element at that index.
int	hashCode()
int	indexOf(java.lang.Object o)
boolean	isEmpty()
java.util.Iterator	iterator()
int	lastIndexOf(java.lang.Object o)
java.util.ListIterator	listIterator()
java.util.ListIterator	listIterator(int index)
java.lang.Object	remove(int index)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection c)
boolean	retainAll(java.util.Collection c)
java.lang.Object	set(int index, java.lang.Object element)
int	size()
java.util.List	subList(int fromIndex, int toIndex)
java.lang.Object[]	toArray()
java.lang.Object[]	toArray(java.lang.Object[] a)

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoPopulatingList

public AutoPopulatingList(java.lang.Class elementClass)

Creates a new AutoPopulatingList that is backed by a standard ArrayList and adds new instances of the supplied element Class to the backing List on demand.

AutoPopulatingList

public AutoPopulatingList(java.util.List backingList,
                          java.lang.Class elementClass)

Creates a new AutoPopulatingList that is backed by the supplied List and adds new instances of the supplied element Class to the backing List on demand.

AutoPopulatingList

public AutoPopulatingList(AutoPopulatingList.ElementFactory elementFactory)

Creates a new AutoPopulatingList that is backed by a standard ArrayList and creates new elements on demand using the supplied AutoPopulatingList.ElementFactory.

AutoPopulatingList

public AutoPopulatingList(java.util.List backingList,
                          AutoPopulatingList.ElementFactory elementFactory)

Creates a new AutoPopulatingList that is backed by the supplied List and creates new elements on demand using the supplied AutoPopulatingList.ElementFactory.

Method Detail

add

public void add(int index,
                java.lang.Object element)

Specified by:

add in interface java.util.List

add

public boolean add(java.lang.Object o)

Specified by:

add in interface java.util.Collection

Specified by:

add in interface java.util.List

addAll

public boolean addAll(java.util.Collection c)

Specified by:

addAll in interface java.util.Collection

Specified by:

addAll in interface java.util.List

addAll

public boolean addAll(int index,
                      java.util.Collection c)

Specified by:

addAll in interface java.util.List

clear

public void clear()

Specified by:

clear in interface java.util.Collection

Specified by:

clear in interface java.util.List

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection

Specified by:

contains in interface java.util.List

containsAll

public boolean containsAll(java.util.Collection c)

Specified by:

containsAll in interface java.util.Collection

Specified by:

containsAll in interface java.util.List

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Collection

Specified by:

equals in interface java.util.List

Overrides:

equals in class java.lang.Object

get

public java.lang.Object get(int index)

Get the element at the supplied index, creating it if there is no element at that index.

Specified by:

get in interface java.util.List

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection

Specified by:

hashCode in interface java.util.List

Overrides:

hashCode in class java.lang.Object

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection

Specified by:

isEmpty in interface java.util.List

iterator

public java.util.Iterator iterator()

Specified by:

iterator in interface java.lang.Iterable

Specified by:

iterator in interface java.util.Collection

Specified by:

iterator in interface java.util.List

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List

listIterator

public java.util.ListIterator listIterator()

Specified by:

listIterator in interface java.util.List

listIterator

public java.util.ListIterator listIterator(int index)

Specified by:

listIterator in interface java.util.List

remove

public java.lang.Object remove(int index)

Specified by:

remove in interface java.util.List

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection

Specified by:

remove in interface java.util.List

removeAll

public boolean removeAll(java.util.Collection c)

Specified by:

removeAll in interface java.util.Collection

Specified by:

removeAll in interface java.util.List

retainAll

public boolean retainAll(java.util.Collection c)

Specified by:

retainAll in interface java.util.Collection

Specified by:

retainAll in interface java.util.List

set

public java.lang.Object set(int index,
                            java.lang.Object element)

Specified by:

set in interface java.util.List

size

public int size()

Specified by:

size in interface java.util.Collection

Specified by:

size in interface java.util.List

subList

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

Specified by:

subList in interface java.util.List

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection

Specified by:

toArray in interface java.util.List

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)

Specified by:

toArray in interface java.util.Collection

Specified by:

toArray in interface java.util.List