oracle.toplink.indirection
Class IndirectList

java.lang.Object
java.util.AbstractCollection
java.util.AbstractList
java.util.Vector
oracle.toplink.indirection.IndirectList

All Implemented Interfaces:

java.lang.Cloneable, java.util.Collection, IndirectContainer, java.util.List, java.util.RandomAccess, java.io.Serializable

Direct Known Subclasses:

EJBIndirectList

public class IndirectList

extends java.util.Vector

implements IndirectContainer

IndirectList allows a domain class to take advantage of TopLink indirection without having to declare its instance variable as a ValueHolderInterface.

To use an IndirectList:

• Declare the appropriate instance variable with type IndirectList (jdk1.1) or Collection/List/Vector (jdk1.2).
• Send the message #useTransparentCollection() to the appropriate CollectionMapping.

TopLink will place an IndirectList in the instance variable when the containing domain object is read from the datatabase. With the first message sent to the IndirectList, the contents are fetched from the database and normal Collection/List/Vector behavior is resumed.

Since:

TOPLink/Java 2.5

See Also:

CollectionMapping, IndirectMap, Serialized Form

Constructor Summary

IndirectList()
PUBLIC: Construct an empty IndirectList so that its internal data array has size 10 and its standard capacity increment is zero.

IndirectList(java.util.Collection c)
PUBLIC: Construct an IndirectList containing the elements of the specified collection, in the order they are returned by the collection's iterator.

IndirectList(int initialCapacity)
PUBLIC: Construct an empty IndirectList with the specified initial capacity and with its capacity increment equal to zero.

IndirectList(int initialCapacity, int capacityIncrement)
PUBLIC: Construct an empty IndirectList with the specified initial capacity and capacity increment.

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	addElement(java.lang.Object obj)
int	capacity()
void	clear()
java.lang.Object	clone() PUBLIC:
boolean	contains(java.lang.Object elem) PUBLIC:
boolean	containsAll(java.util.Collection c)
void	copyInto(java.lang.Object[] anArray)
java.lang.Object	elementAt(int index)
java.util.Enumeration	elements()
void	ensureCapacity(int minCapacity)
boolean	equals(java.lang.Object o)
java.lang.Object	firstElement()
java.lang.Object	get(int index)
ValueHolderInterface	getValueHolder() PUBLIC: Return the valueHolder.
int	indexOf(java.lang.Object elem)
int	indexOf(java.lang.Object elem, int index)
void	insertElementAt(java.lang.Object obj, int index)
boolean	isEmpty()
boolean	isInstantiated() PUBLIC: Return whether the contents have been read from the database.
java.util.Iterator	iterator()
java.lang.Object	lastElement()
int	lastIndexOf(java.lang.Object elem)
int	lastIndexOf(java.lang.Object elem, int index)
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)
void	removeAllElements()
boolean	removeElement(java.lang.Object obj)
void	removeElementAt(int index)
boolean	retainAll(java.util.Collection c)
java.lang.Object	set(int index, java.lang.Object element)
void	setElementAt(java.lang.Object obj, int index)
void	setSize(int newSize)
void	setValueHolder(ValueHolderInterface valueHolder) PUBLIC: Set the value holder.
int	size()
java.util.List	subList(int fromIndex, int toIndex)
java.lang.Object[]	toArray()
java.lang.Object[]	toArray(java.lang.Object[] a)
java.lang.String	toString() PUBLIC: Use the java.util.Vector#toString(); but wrap it with braces to indicate there is a bit of indirection.
void	trimToSize()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IndirectList

public IndirectList()

PUBLIC: Construct an empty IndirectList so that its internal data array has size 10 and its standard capacity increment is zero.

IndirectList

public IndirectList(int initialCapacity)

PUBLIC: Construct an empty IndirectList with the specified initial capacity and with its capacity increment equal to zero.

Parameters:

initialCapacity - the initial capacity of the vector

Throws:

java.lang.IllegalArgumentException - if the specified initial capacity is negative

IndirectList

public IndirectList(int initialCapacity,
                    int capacityIncrement)

PUBLIC: Construct an empty IndirectList with the specified initial capacity and capacity increment.

Parameters:

initialCapacity - the initial capacity of the vector

capacityIncrement - the amount by which the capacity is increased when the vector overflows

Throws:

java.lang.IllegalArgumentException - if the specified initial capacity is negative

IndirectList

public IndirectList(java.util.Collection c)

PUBLIC: Construct an IndirectList containing the elements of the specified collection, in the order they are returned by the collection's iterator.

Parameters:

c - a collection containing the elements to construct this IndirectList with.

Method Detail

add

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

Specified by:

add in interface java.util.List

See Also:

Vector.add(int, java.lang.Object)

add

public boolean add(java.lang.Object o)

Specified by:

add in interface java.util.List

See Also:

Vector.add(java.lang.Object)

addAll

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

Specified by:

addAll in interface java.util.List

See Also:

Vector.addAll(int, java.util.Collection)

addAll

public boolean addAll(java.util.Collection c)

Specified by:

addAll in interface java.util.List

See Also:

Vector.addAll(java.util.Collection)

addElement

public void addElement(java.lang.Object obj)

See Also:

Vector.addElement(java.lang.Object)

capacity

public int capacity()

See Also:

Vector.capacity()

clear

public void clear()

Specified by:

clear in interface java.util.List

See Also:

Vector.clear()

clone

public java.lang.Object clone()

PUBLIC:

See Also:

This will result in a database query if necessary.

contains

public boolean contains(java.lang.Object elem)

PUBLIC:

Specified by:

contains in interface java.util.List

See Also:

Vector.contains(java.lang.Object)

containsAll

public boolean containsAll(java.util.Collection c)

Specified by:

containsAll in interface java.util.List

See Also:

Vector.containsAll(java.util.Collection)

copyInto

public void copyInto(java.lang.Object[] anArray)

See Also:

Vector.copyInto(java.lang.Object[])

elementAt

public java.lang.Object elementAt(int index)

See Also:

Vector.elementAt(int)

elements

public java.util.Enumeration elements()

See Also:

Vector.elements()

ensureCapacity

public void ensureCapacity(int minCapacity)

See Also:

Vector.ensureCapacity(int)

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.List

See Also:

Vector.equals(java.lang.Object)

firstElement

public java.lang.Object firstElement()

See Also:

Vector.firstElement()

get

public java.lang.Object get(int index)

Specified by:

get in interface java.util.List

See Also:

Vector.get(int)

getValueHolder

public ValueHolderInterface getValueHolder()

PUBLIC: Return the valueHolder.

Specified by:

getValueHolder in interface IndirectContainer

Returns:

oracle.toplink.indirection.ValueHolderInterface A representation of the valueholder * which this container uses

indexOf

public int indexOf(java.lang.Object elem)

Specified by:

indexOf in interface java.util.List

See Also:

Vector.indexOf(java.lang.Object)

indexOf

public int indexOf(java.lang.Object elem,
                   int index)

See Also:

Vector.indexOf(java.lang.Object, int)

insertElementAt

public void insertElementAt(java.lang.Object obj,
                            int index)

See Also:

Vector.insertElementAt(java.lang.Object, int)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.List

See Also:

Vector.isEmpty()

isInstantiated

public boolean isInstantiated()

PUBLIC: Return whether the contents have been read from the database.

Specified by:

isInstantiated in interface IndirectContainer

iterator

public java.util.Iterator iterator()

Specified by:

iterator in interface java.util.List

See Also:

AbstractList.iterator()

lastElement

public java.lang.Object lastElement()

See Also:

Vector.lastElement()

lastIndexOf

public int lastIndexOf(java.lang.Object elem)

Specified by:

lastIndexOf in interface java.util.List

See Also:

Vector.lastIndexOf(java.lang.Object)

lastIndexOf

public int lastIndexOf(java.lang.Object elem,
                       int index)

See Also:

Vector.lastIndexOf(java.lang.Object, int)

listIterator

public java.util.ListIterator listIterator()

Specified by:

listIterator in interface java.util.List

See Also:

AbstractList.listIterator()

listIterator

public java.util.ListIterator listIterator(int index)

Specified by:

listIterator in interface java.util.List

See Also:

AbstractList.listIterator(int)

remove

public java.lang.Object remove(int index)

Specified by:

remove in interface java.util.List

See Also:

Vector.remove(int)

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.List

See Also:

Vector.remove(java.lang.Object)

removeAll

public boolean removeAll(java.util.Collection c)

Specified by:

removeAll in interface java.util.List

See Also:

Vector.removeAll(java.util.Collection)

removeAllElements

public void removeAllElements()

See Also:

Vector.removeAllElements()

removeElement

public boolean removeElement(java.lang.Object obj)

See Also:

Vector.removeElement(java.lang.Object)

removeElementAt

public void removeElementAt(int index)

See Also:

Vector.removeElementAt(int)

retainAll

public boolean retainAll(java.util.Collection c)

Specified by:

retainAll in interface java.util.List

See Also:

Vector.retainAll(java.util.Collection)

set

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

Specified by:

set in interface java.util.List

See Also:

Vector.set(int, java.lang.Object)

setElementAt

public void setElementAt(java.lang.Object obj,
                         int index)

See Also:

Vector.setElementAt(java.lang.Object, int)

setSize

public void setSize(int newSize)

See Also:

Vector.setSize(int)

setValueHolder

public void setValueHolder(ValueHolderInterface valueHolder)

PUBLIC: Set the value holder.

Specified by:

setValueHolder in interface IndirectContainer

size

public int size()

Specified by:

size in interface java.util.List

See Also:

Vector.size()

subList

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

Specified by:

subList in interface java.util.List

See Also:

Vector.subList(int, int)

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.List

See Also:

Vector.toArray()

toArray

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

Specified by:

toArray in interface java.util.List

See Also:

Vector.toArray(java.lang.Object[])

toString

public java.lang.String toString()

PUBLIC: Use the java.util.Vector#toString(); but wrap it with braces to indicate there is a bit of indirection. Don't allow this method to trigger a database read.

See Also:

Vector.toString()

trimToSize

public void trimToSize()

See Also:

Vector.trimToSize()