Class ToManyList<E>

java.lang.Object

org.apache.cayenne.access.ToManyHolder<E>

org.apache.cayenne.access.ToManyList<E>

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>, SequencedCollection<E>

public class ToManyList<E>
extends ToManyHolder<E>
implements List<E>

A list that holds objects for to-many relationships, lazily resolved on first access. All operations, except for resolving the list from DB, are not synchronized. The safest way to implement custom synchronization is to synchronize on parent ObjectStore.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<E>	objectList

Fields inherited from class ToManyHolder

addedToUnresolved, relationshipName, relationshipOwner, removedFromUnresolved

Constructor Summary

Constructors

Constructor	Description
ToManyList(Persistent source, String relationship)	Creates ToManyList.

Method Summary

Modifier and Type	Method	Description
void	add(int index, E o)
boolean	add(E o)
boolean	addAll(int index, Collection<? extends E> c)
boolean	addAll(Collection<? extends E> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
E	get(int index)
int	hashCode()
int	indexOf(Object o)
void	invalidate()	Turns this collection into a fault, thus forcing a refresh on the next access.
boolean	isEmpty()
boolean	isFault()	Returns whether this collection is not yet resolved and requires a fetch.
Iterator<E>	iterator()
int	lastIndexOf(Object o)
ListIterator<E>	listIterator()
ListIterator<E>	listIterator(int index)
E	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
protected List<E>	resolvedObjectList()	Returns internal objects list resolving it if needed.
void	resolveWith(Collection<E> objects)	Resolves the list with the given objects.
boolean	retainAll(Collection<?> c)
E	set(int index, E o)
int	size()
List<E>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toString()

Methods inherited from class ToManyHolder

addLocal, isTransientParent, isUncommittedParent, mergeLocalChanges, removeLocal, resolveRelationship

Methods inherited from class Object

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

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface Iterable

forEach

Methods inherited from interface List

addFirst, addLast, getFirst, getLast, removeFirst, removeLast, replaceAll, reversed, sort, spliterator

Field Details

objectList

protected List<E> objectList

Constructor Details

ToManyList

public ToManyList(Persistent source,
 String relationship)

Creates ToManyList.

Since:

1.1

Method Details

isFault

public boolean isFault()

Description copied from class: ToManyHolder

Returns whether this collection is not yet resolved and requires a fetch.

Specified by:

isFault in class ToManyHolder<E>

invalidate

public void invalidate()

Description copied from class: ToManyHolder

Turns this collection into a fault, thus forcing a refresh on the next access.

Specified by:

invalidate in class ToManyHolder<E>

resolveWith

public void resolveWith(Collection<E> objects)

Resolves the list with the given objects. A non-list collection is copied into a new list.

Specified by:

resolveWith in class ToManyHolder<E>

resolvedObjectList

protected List<E> resolvedObjectList()

Returns internal objects list resolving it if needed.

add

public boolean add(E o)

Specified by:

add in interface Collection<E>

Specified by:

add in interface List<E>

add

public void add(int index,
 E o)

Specified by:

add in interface List<E>

addAll

public boolean addAll(Collection<? extends E> c)

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface List<E>

addAll

public boolean addAll(int index,
 Collection<? extends E> c)

Specified by:

addAll in interface List<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface List<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface List<E>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface List<E>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface List<E>

Overrides:

hashCode in class Object

get

public E get(int index)

Specified by:

get in interface List<E>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface List<E>

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>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<E>

listIterator

public ListIterator<E> listIterator()

Specified by:

listIterator in interface List<E>

listIterator

public ListIterator<E> listIterator(int index)

Specified by:

listIterator in interface List<E>

remove

public E remove(int index)

Specified by:

remove in interface List<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface List<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface List<E>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface List<E>

set

public E set(int index,
 E o)

Specified by:

set in interface List<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

subList

public List<E> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

toString

public String toString()

Overrides:

toString in class Object