java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<E>
  - - java.util.Vector<E>
    - - org.eclipse.persistence.indirection.IndirectList<E>

Type Parameters:

E - the type of elements maintained by this list

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Collection<E>, List<E>, RandomAccess, ChangeTracker, CollectionChangeTracker, IndirectCollection, IndirectContainer
```
public class IndirectList<E>
extends Vector<E>
implements CollectionChangeTracker, IndirectCollection
```
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 Collection/List/Vector (jdk1.2).
- Send the message #useTransparentCollection() to the appropriate CollectionMapping.
EclipseLink 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

Author:

Big Country

See Also:

CollectionMapping, IndirectMap, Serialized Form

Constructor Summary

Constructors
Constructor	Description
`IndirectList()`	PUBLIC: Construct an empty IndirectList so that its internal data array has size `10` and its standard capacity increment is zero.
`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.
`IndirectList(Collection<? extends E> collection)`	PUBLIC: Construct an IndirectList containing the elements of the specified collection, in the order they are returned by the collection's iterator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PropertyChangeListener`	`_persistence_getPropertyChangeListener()`	INTERNAL: Return the property change listener for change tracking.
`void`	`_persistence_setPropertyChangeListener(PropertyChangeListener changeListener)`	INTERNAL: Set the property change listener for change tracking.
`void`	`add(int index, E element)`
`boolean`	`add(E element)`
`boolean`	`addAll(int index, Collection<? extends E> c)`
`boolean`	`addAll(Collection<? extends E> c)`
`void`	`addElement(E obj)`
`int`	`capacity()`
`void`	`clear()`
`void`	`clearDeferredChanges()`	INTERNAL: clear any changes that have been deferred to instantiation.
`Object`	`clone()`	PUBLIC:
`boolean`	`contains(Object element)`	PUBLIC:
`boolean`	`containsAll(Collection<?> c)`
`void`	`copyInto(Object[] anArray)`
`E`	`elementAt(int index)`
`Enumeration<E>`	`elements()`
`void`	`ensureCapacity(int minCapacity)`
`boolean`	`equals(Object o)`
`E`	`firstElement()`
`E`	`get(int index)`
`Collection`	`getAddedElements()`	INTERNAL: Return the elements that have been added before instantiation.
`Object`	`getDelegateObject()`	INTERNAL: Return the real collection object.
`Collection`	`getRemovedElements()`	INTERNAL: Return the elements that have been removed before instantiation.
`String`	`getTrackedAttributeName()`	INTERNAL: Return the mapping attribute name, used to raise change events.
`ValueHolderInterface`	`getValueHolder()`	INTERNAL: Return the valueHolder.
`boolean`	`hasAddedElements()`	INTERNAL: Return if any elements that have been added before instantiation.
`boolean`	`hasBeenRegistered()`	INTERNAL: return whether this IndirectList has been registered with the UnitOfWork
`boolean`	`hasDeferredChanges()`	INTERNAL: Return if any elements that have been added or removed before instantiation.
`int`	`hashCode()`	INTERNAL:
`boolean`	`hasRemovedElements()`	INTERNAL: Return if any elements that have been removed before instantiation.
`boolean`	`hasTrackedPropertyChangeListener()`	INTERNAL: Return if the collection has a property change listener for change tracking.
`int`	`indexOf(Object elem)`
`int`	`indexOf(Object elem, int index)`
`void`	`insertElementAt(E obj, int index)`
`boolean`	`isEmpty()`
`boolean`	`isInstantiated()`	PUBLIC: Return whether the contents have been read from the database.
`boolean`	`isListOrderBrokenInDb()`
`Iterator<E>`	`iterator()`
`E`	`lastElement()`
`int`	`lastIndexOf(Object elem)`
`int`	`lastIndexOf(Object elem, int index)`
`ListIterator<E>`	`listIterator()`
`ListIterator<E>`	`listIterator(int index)`
`E`	`remove(int index)`
`boolean`	`remove(Object element)`
`boolean`	`removeAll(Collection<?> c)`
`void`	`removeAllElements()`
`boolean`	`removeElement(Object obj)`
`void`	`removeElementAt(int index)`
`boolean`	`retainAll(Collection<?> c)`
`E`	`set(int index, E element)`
`void`	`setElementAt(E obj, int index)`
`void`	`setIsListOrderBrokenInDb(boolean isBroken)`
`void`	`setSize(int newSize)`
`void`	`setTrackedAttributeName(String attributeName)`	INTERNAL: Set the mapping attribute name, used to raise change events.
`void`	`setUseLazyInstantiation(boolean useLazyInstantiation)`	INTERNAL Set whether this collection should attempt do deal with adds and removes without retrieving the collection from the dB
`void`	`setValueHolder(ValueHolderInterface valueHolder)`	INTERNAL: Set the value holder.
`int`	`size()`
`void`	`sort(Comparator<? super E> c)`	Sort content of this instance according to the order induced by provided comparator.
`List<E>`	`subList(int fromIndex, int toIndex)`
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] a)`
`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.util.Vector
forEach, removeIf, replaceAll, spliterator

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection
parallelStream, stream, toArray

- 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:
    
    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:
    
    IllegalArgumentException - if the specified initial capacity is negative
  - IndirectList
```
public IndirectList(Collection<? extends E> collection)
```
    PUBLIC: Construct an IndirectList containing the elements of the specified collection, in the order they are returned by the collection's iterator.
    
    Parameters:
    
    collection - a collection containing the elements to construct this IndirectList with.
- Method Detail
  - add
```
public void add(int index,
                E element)
```
    Specified by:
    
    add in interface List<E>
    
    Overrides:
    
    add in class Vector<E>
    
    See Also:
    
    Vector.add(int, java.lang.Object)
  - add
```
public boolean add(E element)
```
    Specified by:
    
    add in interface Collection<E>
    
    Specified by:
    
    add in interface List<E>
    
    Overrides:
    
    add in class Vector<E>
    
    See Also:
    
    Vector.add(java.lang.Object)
  - addAll
```
public boolean addAll(int index,
                      Collection<? extends E> c)
```
    Specified by:
    
    addAll in interface List<E>
    
    Overrides:
    
    addAll in class Vector<E>
    
    See Also:
    
    Vector.addAll(int, java.util.Collection)
  - addAll
```
public boolean addAll(Collection<? extends E> c)
```
    Specified by:
    
    addAll in interface Collection<E>
    
    Specified by:
    
    addAll in interface List<E>
    
    Overrides:
    
    addAll in class Vector<E>
    
    See Also:
    
    Vector.addAll(java.util.Collection)
  - addElement
```
public void addElement(E obj)
```
    Overrides:
    
    addElement in class Vector<E>
    
    See Also:
    
    Vector.addElement(java.lang.Object)
  - capacity
```
public int capacity()
```
    Overrides:
    
    capacity in class Vector<E>
    
    See Also:
    
    Vector.capacity()
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<E>
    
    Specified by:
    
    clear in interface List<E>
    
    Overrides:
    
    clear in class Vector<E>
    
    See Also:
    
    Vector.clear()
  - clearDeferredChanges
```
public void clearDeferredChanges()
```
    INTERNAL: clear any changes that have been deferred to instantiation. Indirect collections with change tracking avoid instantiation on add/remove.
    
    Specified by:
    
    clearDeferredChanges in interface IndirectCollection
  - clone
```
public Object clone()
```
    PUBLIC:
    
    Overrides:
    
    clone in class Vector<E>
    
    See Also:
    
    This will result in a database query if necessary.
  - contains
```
public boolean contains(Object element)
```
    PUBLIC:
    
    Specified by:
    
    contains in interface Collection<E>
    
    Specified by:
    
    contains in interface List<E>
    
    Overrides:
    
    contains in class Vector<E>
    
    See Also:
    
    Vector.contains(java.lang.Object)
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<E>
    
    Specified by:
    
    containsAll in interface List<E>
    
    Overrides:
    
    containsAll in class Vector<E>
    
    See Also:
    
    Vector.containsAll(java.util.Collection)
  - copyInto
```
public void copyInto(Object[] anArray)
```
    Overrides:
    
    copyInto in class Vector<E>
    
    See Also:
    
    Vector.copyInto(java.lang.Object[])
  - elementAt
```
public E elementAt(int index)
```
    Overrides:
    
    elementAt in class Vector<E>
    
    See Also:
    
    Vector.elementAt(int)
  - elements
```
public Enumeration<E> elements()
```
    Overrides:
    
    elements in class Vector<E>
    
    See Also:
    
    Vector.elements()
  - ensureCapacity
```
public void ensureCapacity(int minCapacity)
```
    Overrides:
    
    ensureCapacity in class Vector<E>
    
    See Also:
    
    Vector.ensureCapacity(int)
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Collection<E>
    
    Specified by:
    
    equals in interface List<E>
    
    Overrides:
    
    equals in class Vector<E>
    
    See Also:
    
    Vector.equals(java.lang.Object)
  - firstElement
```
public E firstElement()
```
    Overrides:
    
    firstElement in class Vector<E>
    
    See Also:
    
    Vector.firstElement()
  - get
```
public E get(int index)
```
    Specified by:
    
    get in interface List<E>
    
    Overrides:
    
    get in class Vector<E>
    
    See Also:
    
    Vector.get(int)
  - getDelegateObject
```
public Object getDelegateObject()
```
    INTERNAL: Return the real collection object. This will force instantiation.
    
    Specified by:
    
    getDelegateObject in interface IndirectCollection
  - getValueHolder
```
public ValueHolderInterface getValueHolder()
```
    INTERNAL: Return the valueHolder. This method used to be synchronized, which caused deadlock.
    
    Specified by:
    
    getValueHolder in interface IndirectContainer
    
    Returns:
    
    org.eclipse.persistence.indirection.ValueHolderInterface A representation of the valueholder * which this container uses
  - hasBeenRegistered
```
public boolean hasBeenRegistered()
```
    INTERNAL: return whether this IndirectList has been registered with the UnitOfWork
  - hashCode
```
public int hashCode()
```
    INTERNAL:
    
    Specified by:
    
    hashCode in interface Collection<E>
    
    Specified by:
    
    hashCode in interface List<E>
    
    Overrides:
    
    hashCode in class Vector<E>
    
    See Also:
    
    Vector.hashCode()
  - indexOf
```
public int indexOf(Object elem)
```
    Specified by:
    
    indexOf in interface List<E>
    
    Overrides:
    
    indexOf in class Vector<E>
    
    See Also:
    
    Vector.indexOf(java.lang.Object)
  - indexOf
```
public int indexOf(Object elem,
                   int index)
```
    Overrides:
    
    indexOf in class Vector<E>
    
    See Also:
    
    Vector.indexOf(java.lang.Object, int)
  - insertElementAt
```
public void insertElementAt(E obj,
                            int index)
```
    Overrides:
    
    insertElementAt in class Vector<E>
    
    See Also:
    
    Vector.insertElementAt(java.lang.Object, int)
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<E>
    
    Specified by:
    
    isEmpty in interface List<E>
    
    Overrides:
    
    isEmpty in class Vector<E>
    
    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 Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Collection<E>
    
    Specified by:
    
    iterator in interface Iterable<E>
    
    Specified by:
    
    iterator in interface List<E>
    
    Overrides:
    
    iterator in class Vector<E>
    
    See Also:
    
    AbstractList.iterator()
  - lastElement
```
public E lastElement()
```
    Overrides:
    
    lastElement in class Vector<E>
    
    See Also:
    
    Vector.lastElement()
  - lastIndexOf
```
public int lastIndexOf(Object elem)
```
    Specified by:
    
    lastIndexOf in interface List<E>
    
    Overrides:
    
    lastIndexOf in class Vector<E>
    
    See Also:
    
    Vector.lastIndexOf(java.lang.Object)
  - lastIndexOf
```
public int lastIndexOf(Object elem,
                       int index)
```
    Overrides:
    
    lastIndexOf in class Vector<E>
    
    See Also:
    
    Vector.lastIndexOf(java.lang.Object, int)
  - listIterator
```
public ListIterator<E> listIterator()
```
    Specified by:
    
    listIterator in interface List<E>
    
    Overrides:
    
    listIterator in class Vector<E>
    
    See Also:
    
    AbstractList.listIterator()
  - listIterator
```
public ListIterator<E> listIterator(int index)
```
    Specified by:
    
    listIterator in interface List<E>
    
    Overrides:
    
    listIterator in class Vector<E>
    
    See Also:
    
    AbstractList.listIterator(int)
  - remove
```
public E remove(int index)
```
    Specified by:
    
    remove in interface List<E>
    
    Overrides:
    
    remove in class Vector<E>
    
    See Also:
    
    Vector.remove(int)
  - remove
```
public boolean remove(Object element)
```
    Specified by:
    
    remove in interface Collection<E>
    
    Specified by:
    
    remove in interface List<E>
    
    Overrides:
    
    remove in class Vector<E>
    
    See Also:
    
    Vector.remove(java.lang.Object)
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<E>
    
    Specified by:
    
    removeAll in interface List<E>
    
    Overrides:
    
    removeAll in class Vector<E>
    
    See Also:
    
    Vector.removeAll(java.util.Collection)
  - removeAllElements
```
public void removeAllElements()
```
    Overrides:
    
    removeAllElements in class Vector<E>
    
    See Also:
    
    Vector.removeAllElements()
  - removeElement
```
public boolean removeElement(Object obj)
```
    Overrides:
    
    removeElement in class Vector<E>
    
    See Also:
    
    Vector.removeElement(java.lang.Object)
  - removeElementAt
```
public void removeElementAt(int index)
```
    Overrides:
    
    removeElementAt in class Vector<E>
    
    See Also:
    
    Vector.removeElementAt(int)
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<E>
    
    Specified by:
    
    retainAll in interface List<E>
    
    Overrides:
    
    retainAll in class Vector<E>
    
    See Also:
    
    Vector.retainAll(java.util.Collection)
  - set
```
public E set(int index,
             E element)
```
    Specified by:
    
    set in interface List<E>
    
    Overrides:
    
    set in class Vector<E>
    
    See Also:
    
    Vector.set(int, java.lang.Object)
  - setElementAt
```
public void setElementAt(E obj,
                         int index)
```
    Overrides:
    
    setElementAt in class Vector<E>
    
    See Also:
    
    Vector.setElementAt(java.lang.Object, int)
  - setSize
```
public void setSize(int newSize)
```
    Overrides:
    
    setSize in class Vector<E>
    
    See Also:
    
    Vector.setSize(int)
  - setUseLazyInstantiation
```
public void setUseLazyInstantiation(boolean useLazyInstantiation)
```
    INTERNAL Set whether this collection should attempt do deal with adds and removes without retrieving the collection from the dB
    
    Specified by:
    
    setUseLazyInstantiation in interface IndirectCollection
  - setValueHolder
```
public void setValueHolder(ValueHolderInterface valueHolder)
```
    INTERNAL: Set the value holder.
    
    Specified by:
    
    setValueHolder in interface IndirectContainer
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<E>
    
    Specified by:
    
    size in interface List<E>
    
    Overrides:
    
    size in class Vector<E>
    
    See Also:
    
    Vector.size()
  - sort
```
public void sort(Comparator<? super E> c)
```
    Sort content of this instance according to the order induced by provided comparator.
    
    Specified by:
    
    sort in interface List<E>
    
    Overrides:
    
    sort in class Vector<E>
    
    Parameters:
    
    c - The comparator to determine the order of the array. A null value indicates that the elements' natural ordering should be used.
    
    Since:
    
    2.6.0 with JDK 1.8
  - subList
```
public List<E> subList(int fromIndex,
                       int toIndex)
```
    Specified by:
    
    subList in interface List<E>
    
    Overrides:
    
    subList in class Vector<E>
    
    See Also:
    
    Vector.subList(int, int)
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface List<E>
    
    Overrides:
    
    toArray in class Vector<E>
    
    See Also:
    
    Vector.toArray()
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface List<E>
    
    Overrides:
    
    toArray in class Vector<E>
    
    See Also:
    
    Vector.toArray(java.lang.Object[])
  - toString
```
public 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.
    
    Overrides:
    
    toString in class Vector<E>
    
    See Also:
    
    Vector.toString()
  - trimToSize
```
public void trimToSize()
```
    Overrides:
    
    trimToSize in class Vector<E>
    
    See Also:
    
    Vector.trimToSize()
  - _persistence_getPropertyChangeListener
```
public PropertyChangeListener _persistence_getPropertyChangeListener()
```
    INTERNAL: Return the property change listener for change tracking.
    
    Specified by:
    
    _persistence_getPropertyChangeListener in interface ChangeTracker
  - hasTrackedPropertyChangeListener
```
public boolean hasTrackedPropertyChangeListener()
```
    INTERNAL: Return if the collection has a property change listener for change tracking.
  - _persistence_setPropertyChangeListener
```
public void _persistence_setPropertyChangeListener(PropertyChangeListener changeListener)
```
    INTERNAL: Set the property change listener for change tracking.
    
    Specified by:
    
    _persistence_setPropertyChangeListener in interface ChangeTracker
  - getTrackedAttributeName
```
public String getTrackedAttributeName()
```
    INTERNAL: Return the mapping attribute name, used to raise change events.
    
    Specified by:
    
    getTrackedAttributeName in interface CollectionChangeTracker
  - setTrackedAttributeName
```
public void setTrackedAttributeName(String attributeName)
```
    INTERNAL: Set the mapping attribute name, used to raise change events. This is required if the change listener is set.
    
    Specified by:
    
    setTrackedAttributeName in interface CollectionChangeTracker
  - getRemovedElements
```
public Collection getRemovedElements()
```
    INTERNAL: Return the elements that have been removed before instantiation.
    
    Specified by:
    
    getRemovedElements in interface IndirectCollection
  - getAddedElements
```
public Collection getAddedElements()
```
    INTERNAL: Return the elements that have been added before instantiation.
    
    Specified by:
    
    getAddedElements in interface IndirectCollection
  - hasAddedElements
```
public boolean hasAddedElements()
```
    INTERNAL: Return if any elements that have been added before instantiation.
  - hasRemovedElements
```
public boolean hasRemovedElements()
```
    INTERNAL: Return if any elements that have been removed before instantiation.
  - hasDeferredChanges
```
public boolean hasDeferredChanges()
```
    INTERNAL: Return if any elements that have been added or removed before instantiation.
    
    Specified by:
    
    hasDeferredChanges in interface IndirectCollection
  - isListOrderBrokenInDb
```
public boolean isListOrderBrokenInDb()
```
  - setIsListOrderBrokenInDb
```
public void setIsListOrderBrokenInDb(boolean isBroken)
```

Class IndirectList<E>

Constructor Summary

Method Summary

Methods inherited from class java.util.Vector

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Constructor Detail

IndirectList

IndirectList

IndirectList

IndirectList

Method Detail

add

add

addAll

addAll

addElement

capacity

clear

clearDeferredChanges

clone

contains

containsAll

copyInto

elementAt

elements

ensureCapacity

equals

firstElement

get

getDelegateObject

getValueHolder

hasBeenRegistered

hashCode

indexOf

indexOf

insertElementAt

isEmpty

isInstantiated

iterator

lastElement

lastIndexOf

lastIndexOf

listIterator

listIterator

remove

remove

removeAll

removeAllElements

removeElement

removeElementAt

retainAll

set

setElementAt

setSize

setUseLazyInstantiation

setValueHolder

size

sort

subList

toArray

toArray

toString

trimToSize

_persistence_getPropertyChangeListener

hasTrackedPropertyChangeListener

_persistence_setPropertyChangeListener

getTrackedAttributeName

setTrackedAttributeName

getRemovedElements

getAddedElements

hasAddedElements

hasRemovedElements

hasDeferredChanges

isListOrderBrokenInDb

setIsListOrderBrokenInDb