Package org.datanucleus.store.types.wrappers

Class List<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

org.datanucleus.store.types.wrappers.List<E>

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Collection<E>, List<E>, SCO<List<E>>, SCOCollection<List<E>,E>, SCOContainer<List<E>>, SCOList<List<E>,E>

Direct Known Subclasses:

List

public class List<E>
extends AbstractList<E>
implements SCOList<List<E>,E>, Cloneable, Serializable

A mutable second-class List object. This is the simplified form that intercepts mutators and marks the field as dirty. It also handles cascade-delete triggering for persistable elements.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<E>	delegate	The internal "delegate".
protected AbstractMemberMetaData	ownerMmd
protected ObjectProvider	ownerOP
protected boolean	sorting

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
List(ObjectProvider ownerOP, AbstractMemberMetaData mmd)	Constructor, using the ObjectProvider of the "owner" and the field name.

Method Summary

Modifier and Type	Method	Description
void	add(int index, E element)	Method to add an element to the List at a position.
boolean	add(E element)	Method to add an element to the List
boolean	addAll(int index, Collection elements)	Method to add a collection of elements.
boolean	addAll(Collection elements)	Method to add a Collection to the ArrayList.
void	attachCopy(List value)	Method to return an attached copy of the passed (detached) value.
void	clear()	Method to clear the List
Object	clone()	Creates and returns a copy of this object.
boolean	contains(Object element)	Accessor for whether an element is contained in the List.
boolean	containsAll(Collection c)	Accessor for whether a collection of elements are contained here.
List	detachCopy(FetchPlanState state)	Method to return a detached copy of the container.
boolean	equals(Object o)	Equality operator.
void	forEach(java.util.function.Consumer action)
E	get(int index)	Method to retrieve an element no.
String	getFieldName()	Accessor for the field name.
Object	getOwner()	Accessor for the owner object.
List<E>	getValue()	Accessor for the unwrapped value that we are wrapping.
int	hashCode()
int	indexOf(Object element)	Method to the position of an element.
void	initialise()	Method to initialise the SCO for use, and allowing the SCO to be loaded from the datastore (when we have a backing store).
void	initialise(List c)	Method to initialise the SCO for use with the provided initial value.
void	initialise(List<E> newValue, Object oldValue)	Method to initialise the SCO for use, where replacing an old value with a new value such as when calling a setter field passing in a new value.
boolean	isEmpty()	Accessor for whether the List is empty.
boolean	isLoaded()	Method to return if the SCO has its contents loaded.
Iterator	iterator()	Accessor for an iterator for the List
int	lastIndexOf(Object element)	Method to retrieve the last position of the element.
ListIterator	listIterator()	Method to retrieve a List iterator for the list.
ListIterator	listIterator(int index)	Method to retrieve a List iterator for the list from the index.
void	load()	Method to effect the load of the data in the SCO.
void	makeDirty()	Utility to mark the object as dirty
java.util.stream.Stream	parallelStream()
E	remove(int index)	Method to remove an element from the ArrayList.
boolean	remove(Object element)	Method to remove an element from the List
boolean	remove(Object element, boolean allowCascadeDelete)	Method to remove an element from the List
boolean	removeAll(Collection elements)	Method to remove a collection of elements from the List.
boolean	retainAll(Collection c)	Method to retain a Collection of elements (and remove all others).
E	set(int index, E element)	Method to set the element at a position in the ArrayList.
E	set(int index, E element, boolean allowDependentField)	wrapper addition that allows turning off of the dependent-field checks when doing the position setting.
void	setValue(List<E> value)	Method to change the delegate value this wraps (to save recreating the wrapper).
int	size()	Accessor for the size of the List
void	sort(Comparator<? super E> comp)
Spliterator	spliterator()
java.util.stream.Stream	stream()
List<E>	subList(int from, int to)	Accessor for the subList of elements between from and to of the List
Object[]	toArray()	Method to return the List as an array.
Object[]	toArray(Object[] a)	Method to return the List as an array.
void	unsetOwner()	Method to unset the owner and field information.
void	updateEmbeddedElement(E element, int fieldNumber, Object value, boolean makeDirty)	Method to update an embedded element in this collection.
protected Object	writeReplace()	The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream.

Methods inherited from class java.util.AbstractList

removeRange

Methods inherited from class java.util.AbstractCollection

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

removeIf, toArray

Methods inherited from interface java.util.List

replaceAll

Field Detail

ownerOP

protected ObjectProvider ownerOP

ownerMmd

protected AbstractMemberMetaData ownerMmd

delegate

protected List<E> delegate

The internal "delegate".

sorting

protected boolean sorting

Constructor Detail

List

public List(ObjectProvider ownerOP,
            AbstractMemberMetaData mmd)

Constructor, using the ObjectProvider of the "owner" and the field name.

Parameters:

ownerOP - The owner ObjectProvider

mmd - Metadata for the member

Method Detail

initialise

public void initialise(List<E> newValue,
                       Object oldValue)

Description copied from interface: SCO

Method to initialise the SCO for use, where replacing an old value with a new value such as when calling a setter field passing in a new value. Note that oldValue is marked as Object since for cases where the member type is Collection the newValue could be, for example, ArrayList, and the oldValue of type Collection (representing null).

Specified by:

initialise in interface SCO<E>

Parameters:

newValue - New value (to wrap)

oldValue - Old value (to use in deciding what needs deleting etc)

initialise

public void initialise(List c)

Description copied from interface: SCO

Method to initialise the SCO for use with the provided initial value. This is used, for example, when retrieving the field from the datastore and setting it in the persistable object.

Specified by:

initialise in interface SCO<E>

Parameters:

c - the object from which to copy the value.

initialise

public void initialise()

Description copied from interface: SCO

Method to initialise the SCO for use, and allowing the SCO to be loaded from the datastore (when we have a backing store). This can be utilised to perform any eager loading of information from the datastore.

Specified by:

initialise in interface SCO<E>

getValue

public List<E> getValue()

Accessor for the unwrapped value that we are wrapping.

Specified by:

getValue in interface SCO<E>

Returns:

The unwrapped value

setValue

public void setValue(List<E> value)

Description copied from interface: SCOContainer

Method to change the delegate value this wraps (to save recreating the wrapper).

Specified by:

setValue in interface SCOContainer<E>

Parameters:

value - The new value

load

public void load()

Method to effect the load of the data in the SCO. Used when the SCO supports lazy-loading to tell it to load all now.

Specified by:

load in interface SCOContainer<E>

isLoaded

public boolean isLoaded()

Method to return if the SCO has its contents loaded. Returns true.

Specified by:

isLoaded in interface SCOContainer<E>

Returns:

Whether it is loaded

updateEmbeddedElement

public void updateEmbeddedElement(E element,
                                  int fieldNumber,
                                  Object value,
                                  boolean makeDirty)

Method to update an embedded element in this collection.

Specified by:

updateEmbeddedElement in interface SCOCollection<List<E>,E>

Parameters:

element - The element

fieldNumber - Number of field in the element

value - New value for this field

makeDirty - Whether to make the SCO field dirty.

getFieldName

public String getFieldName()

Accessor for the field name.

Specified by:

getFieldName in interface SCO<E>

Returns:

The field name

getOwner

public Object getOwner()

Accessor for the owner object.

Specified by:

getOwner in interface SCO<E>

Returns:

The owner object

unsetOwner

public void unsetOwner()

Method to unset the owner and field information.

Specified by:

unsetOwner in interface SCO<E>

makeDirty

public void makeDirty()

Utility to mark the object as dirty

detachCopy

public List detachCopy(FetchPlanState state)

Method to return a detached copy of the container. Recurse sthrough the elements so that they are likewise detached.

Specified by:

detachCopy in interface SCO<E>

Parameters:

state - State for detachment process

Returns:

The detached container

attachCopy

public void attachCopy(List value)

Method to return an attached copy of the passed (detached) value. The returned attached copy is a SCO wrapper. Goes through the existing elements in the store for this owner field and removes ones no longer present, and adds new elements. All elements in the (detached) value are attached.

Specified by:

attachCopy in interface SCO<E>

Parameters:

value - The new (collection) value

clone

public Object clone()

Creates and returns a copy of this object.

Mutable second-class Objects are required to provide a public clone method in order to allow for copying persistable objects. In contrast to Object.clone(), this method must not throw a CloneNotSupportedException.

Specified by:

clone in interface SCO<E>

Overrides:

clone in class Object

Returns:

The cloned object

contains

public boolean contains(Object element)

Accessor for whether an element is contained in the List.

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface List<E>

Overrides:

contains in class AbstractCollection<E>

Parameters:

element - The element

Returns:

Whether the element is contained here

containsAll

public boolean containsAll(Collection c)

Accessor for whether a collection of elements are contained here.

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface List<E>

Overrides:

containsAll in class AbstractCollection<E>

Parameters:

c - The collection of elements.

Returns:

Whether they are contained.

equals

public boolean equals(Object o)

Equality operator.

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface List<E>

Overrides:

equals in class AbstractList<E>

Parameters:

o - The object to compare against.

Returns:

Whether this object is the same.

get

public E get(int index)

Method to retrieve an element no.

Specified by:

get in interface List<E>

Specified by:

get in class AbstractList<E>

Parameters:

index - The item to retrieve

Returns:

The element at that position.

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface List<E>

Overrides:

hashCode in class AbstractList<E>

indexOf

public int indexOf(Object element)

Method to the position of an element.

Specified by:

indexOf in interface List<E>

Overrides:

indexOf in class AbstractList<E>

Parameters:

element - The element.

Returns:

The position.

isEmpty

public boolean isEmpty()

Accessor for whether the List is empty.

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface List<E>

Overrides:

isEmpty in class AbstractCollection<E>

Returns:

Whether it is empty.

lastIndexOf

public int lastIndexOf(Object element)

Method to retrieve the last position of the element.

Specified by:

lastIndexOf in interface List<E>

Overrides:

lastIndexOf in class AbstractList<E>

Parameters:

element - The element

Returns:

The last position of this element in the List.

iterator

public Iterator iterator()

Accessor for an iterator for the List

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 AbstractList<E>

Returns:

The iterator

listIterator

public ListIterator listIterator()

Method to retrieve a List iterator for the list.

Specified by:

listIterator in interface List<E>

Overrides:

listIterator in class AbstractList<E>

Returns:

The iterator

listIterator

public ListIterator listIterator(int index)

Method to retrieve a List iterator for the list from the index.

Specified by:

listIterator in interface List<E>

Overrides:

listIterator in class AbstractList<E>

Parameters:

index - The start point

Returns:

The iterator

size

public int size()

Accessor for the size of the List

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

Specified by:

size in class AbstractCollection<E>

Returns:

The size

subList

public List<E> subList(int from,
                       int to)

Accessor for the subList of elements between from and to of the List

Specified by:

subList in interface List<E>

Overrides:

subList in class AbstractList<E>

Parameters:

from - Start index (inclusive)

to - End index (exclusive)

Returns:

The subList

toArray

public Object[] toArray()

Method to return the List as an array.

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

Overrides:

toArray in class AbstractCollection<E>

Returns:

The array

toArray

public Object[] toArray(Object[] a)

Method to return the List as an array.

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

Overrides:

toArray in class AbstractCollection<E>

Parameters:

a - The array to copy to

Returns:

The array

add

public boolean add(E element)

Method to add an element to the List

Specified by:

add in interface Collection<E>

Specified by:

add in interface List<E>

Overrides:

add in class AbstractList<E>

Parameters:

element - The element to add

Returns:

Whether it was added successfully.

add

public void add(int index,
                E element)

Method to add an element to the List at a position.

Specified by:

add in interface List<E>

Overrides:

add in class AbstractList<E>

Parameters:

element - The element to add

index - The position

addAll

public boolean addAll(Collection elements)

Method to add a Collection to the ArrayList.

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface List<E>

Overrides:

addAll in class AbstractCollection<E>

Parameters:

elements - The collection

Returns:

Whether it was added ok.

addAll

public boolean addAll(int index,
                      Collection elements)

Method to add a collection of elements.

Specified by:

addAll in interface List<E>

Overrides:

addAll in class AbstractList<E>

Parameters:

elements - The collection of elements to add.

index - The position to add them

Returns:

Whether they were added successfully.

clear

public void clear()

Method to clear the List

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

Overrides:

clear in class AbstractList<E>

remove

public boolean remove(Object element)

Method to remove an element from the List

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface List<E>

Overrides:

remove in class AbstractCollection<E>

Parameters:

element - The Element to remove

Returns:

Whether it was removed successfully.

remove

public boolean remove(Object element,
                      boolean allowCascadeDelete)

Method to remove an element from the List

Specified by:

remove in interface SCOCollection<List<E>,E>

Parameters:

element - The Element to remove

allowCascadeDelete - Whether to allow cascade delete

Returns:

Whether it was removed successfully.

remove

public E remove(int index)

Method to remove an element from the ArrayList.

Specified by:

remove in interface List<E>

Overrides:

remove in class AbstractList<E>

Parameters:

index - The element position.

Returns:

The object that was removed

removeAll

public boolean removeAll(Collection elements)

Method to remove a collection of elements from the List.

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface List<E>

Overrides:

removeAll in class AbstractCollection<E>

Parameters:

elements - Collection of elements to remove

Returns:

Whether it was successful.

retainAll

public boolean retainAll(Collection c)

Method to retain a Collection of elements (and remove all others).

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface List<E>

Overrides:

retainAll in class AbstractCollection<E>

Parameters:

c - The collection to retain

Returns:

Whether they were retained successfully.

set

public E set(int index,
             E element,
             boolean allowDependentField)

wrapper addition that allows turning off of the dependent-field checks when doing the position setting. This means that we can prevent the deletion of the object that was previously in that position. This particular feature is used when attaching a list field and where some elements have changed positions.

Specified by:

set in interface SCOList<List<E>,E>

Parameters:

index - The position

element - The new element

allowDependentField - Whether to allow dependent-field deletes

Returns:

The element previously at that position

set

public E set(int index,
             E element)

Method to set the element at a position in the ArrayList.

Specified by:

set in interface List<E>

Overrides:

set in class AbstractList<E>

Parameters:

index - The position

element - The new element

Returns:

The element previously at that position

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream. The ObjectOutputStream checks whether the class defines the writeReplace method. If the method is defined, the writeReplace method is called to allow the object to designate its replacement in the stream. The object returned should be either of the same type as the object passed in or an object that when read and resolved will result in an object of a type that is compatible with all references to the object.

Returns:

the replaced object

Throws:

ObjectStreamException - if an error occurs

stream

public java.util.stream.Stream stream()

Specified by:

stream in interface Collection<E>

parallelStream

public java.util.stream.Stream parallelStream()

Specified by:

parallelStream in interface Collection<E>

forEach

public void forEach(java.util.function.Consumer action)

Specified by:

forEach in interface Iterable<E>

spliterator

public Spliterator spliterator()

Specified by:

spliterator in interface Collection<E>

Specified by:

spliterator in interface Iterable<E>

Specified by:

spliterator in interface List<E>

sort

public void sort(Comparator<? super E> comp)

Specified by:

sort in interface List<E>