Class List<E>
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractList<E>
-
- org.datanucleus.store.types.wrappers.List<E>
-
- org.datanucleus.store.types.wrappers.backed.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>
,BackedSCO
public class List<E> extends List<E> implements BackedSCO
A mutable second-class List object. This class extends AbstractList, using that class to contain the current objects, and the backing ListStore to be the interface to the datastore. A "backing store" is not present for datastores that dont use DatastoreClass, or if the container is serialised or non-persistent.Modes of Operation
The user can operate the list in 2 modes. The cached mode will use an internal cache of the elements (in the "delegate") reading them at the first opportunity and then using the cache thereafter. The non-cached mode will just go direct to the "backing store" each call.Mutators
When the "backing store" is present any updates are passed direct to the datastore as well as to the "delegate". If the "backing store" isn't present the changes are made to the "delegate" only.Accessors
When any accessor method is invoked, it typically checks whether the container has been loaded from its "backing store" (where present) and does this as necessary. Some methods (size()) just check if everything is loaded and use the delegate if possible, otherwise going direct to the datastore.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
allowNulls
protected ListStore<E>
backingStore
protected boolean
isCacheLoaded
protected boolean
useCache
-
Fields inherited from class org.datanucleus.store.types.wrappers.List
delegate, ownerMmd, ownerSM, sorting
-
Fields inherited from class java.util.AbstractList
modCount
-
-
Constructor Summary
Constructors Constructor Description List(DNStateManager ownerSM, AbstractMemberMetaData mmd)
Constructor, using StateManager of the "owner" and the field name.
-
Method Summary
All Methods Instance Methods Concrete Methods 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 Listboolean
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
clear()
Method to clear the ListObject
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.boolean
equals(Object o)
Equality operator.void
forEach(Consumer action)
E
get(int index)
Method to retrieve an element no.Store
getBackingStore()
List
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.void
initialise(List c)
Method to initialise the SCO from an existing value.void
initialise(List 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<E>
iterator()
Accessor for an iterator for the Listint
lastIndexOf(Object element)
Method to retrieve the last position of the element.ListIterator<E>
listIterator()
Method to retrieve a List iterator for the list.ListIterator<E>
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.protected void
loadFromStore()
Method to load all elements from the "backing store" where appropriate.Stream
parallelStream()
E
remove(int index)
Method to remove an element from the ArrayList.boolean
remove(Object element)
Method to remove (the first occurrence of) an element from the collectionboolean
remove(Object element, boolean allowCascadeDelete)
Method to remove (the first occurrence of) an element from the collectionboolean
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.int
size()
Accessor for the size of the ListSpliterator
spliterator()
Stream
stream()
List<E>
subList(int from, int to)
Accessor for the subList of elements between from and to of the ListObject[]
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 org.datanucleus.store.types.wrappers.List
attachCopy, detachCopy, getFieldName, getOwner, makeDirty, setValue, sort
-
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
-
-
-
-
Constructor Detail
-
List
public List(DNStateManager ownerSM, AbstractMemberMetaData mmd)
Constructor, using StateManager of the "owner" and the field name.- Parameters:
ownerSM
- The owner StateManagermmd
- Metadata for the member
-
-
Method Detail
-
initialise
public void initialise(List 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 interfaceSCO<E>
- Overrides:
initialise
in classList<E>
- Parameters:
newValue
- New value (to wrap)oldValue
- Old value (to use in deciding what needs deleting etc)
-
initialise
public void initialise(List c)
Method to initialise the SCO from an existing value.- Specified by:
initialise
in interfaceSCO<E>
- Overrides:
initialise
in classList<E>
- Parameters:
c
- The object to set from
-
initialise
public void initialise()
Method to initialise the SCO for use.- Specified by:
initialise
in interfaceSCO<E>
- Overrides:
initialise
in classList<E>
-
getValue
public List getValue()
Accessor for the unwrapped value that we are wrapping.
-
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.
-
isLoaded
public boolean isLoaded()
Method to return if the SCO has its contents loaded. If the SCO doesn't support lazy loading will just return true.
-
loadFromStore
protected void loadFromStore()
Method to load all elements from the "backing store" where appropriate.
-
getBackingStore
public Store getBackingStore()
- Specified by:
getBackingStore
in interfaceBackedSCO
-
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 interfaceSCOCollection<List<E>,E>
- Overrides:
updateEmbeddedElement
in classList<E>
- Parameters:
element
- The elementfieldNumber
- Number of field in the elementvalue
- New value for this fieldmakeDirty
- Whether to make the SCO field dirty.
-
unsetOwner
public void unsetOwner()
Method to unset the owner and field information.- Specified by:
unsetOwner
in interfaceSCO<E>
- Overrides:
unsetOwner
in classList<E>
-
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.
-
contains
public boolean contains(Object element)
Description copied from class:List
Accessor for whether an element is contained in the List.
-
containsAll
public boolean containsAll(Collection c)
Description copied from class:List
Accessor for whether a collection of elements are contained here.- Specified by:
containsAll
in interfaceCollection<E>
- Specified by:
containsAll
in interfaceList<E>
- Overrides:
containsAll
in classList<E>
- Parameters:
c
- The collection of elements.- Returns:
- Whether they are contained.
-
forEach
public void forEach(Consumer action)
-
hashCode
public int hashCode()
-
indexOf
public int indexOf(Object element)
Description copied from class:List
Method to the position of an element.
-
isEmpty
public boolean isEmpty()
Description copied from class:List
Accessor for whether the List is empty.
-
lastIndexOf
public int lastIndexOf(Object element)
Description copied from class:List
Method to retrieve the last position of the element.- Specified by:
lastIndexOf
in interfaceList<E>
- Overrides:
lastIndexOf
in classList<E>
- Parameters:
element
- The element- Returns:
- The last position of this element in the List.
-
iterator
public Iterator<E> iterator()
Description copied from class:List
Accessor for an iterator for the List
-
listIterator
public ListIterator<E> listIterator()
Description copied from class:List
Method to retrieve a List iterator for the list.- Specified by:
listIterator
in interfaceList<E>
- Overrides:
listIterator
in classList<E>
- Returns:
- The iterator
-
listIterator
public ListIterator<E> listIterator(int index)
Description copied from class:List
Method to retrieve a List iterator for the list from the index.- Specified by:
listIterator
in interfaceList<E>
- Overrides:
listIterator
in classList<E>
- Parameters:
index
- The start point- Returns:
- The iterator
-
size
public int size()
Description copied from class:List
Accessor for the size of the List
-
subList
public List<E> subList(int from, int to)
Description copied from class:List
Accessor for the subList of elements between from and to of the List
-
toArray
public Object[] toArray()
Description copied from class:List
Method to return the List as an array.
-
toArray
public Object[] toArray(Object[] a)
Description copied from class:List
Method to return the List as an array.
-
add
public boolean add(E element)
Description copied from class:List
Method to add an element to the List
-
add
public void add(int index, E element)
Description copied from class:List
Method to add an element to the List at a position.
-
addAll
public boolean addAll(Collection elements)
Description copied from class:List
Method to add a Collection to the ArrayList.
-
addAll
public boolean addAll(int index, Collection elements)
Description copied from class:List
Method to add a collection of elements.
-
clear
public void clear()
Description copied from class:List
Method to clear the List
-
remove
public boolean remove(Object element)
Description copied from class:List
Method to remove (the first occurrence of) an element from the collection
-
remove
public boolean remove(Object element, boolean allowCascadeDelete)
Description copied from class:List
Method to remove (the first occurrence of) an element from the collection
-
remove
public E remove(int index)
Description copied from class:List
Method to remove an element from the ArrayList.
-
removeAll
public boolean removeAll(Collection elements)
Description copied from class:List
Method to remove a collection of elements from the List.
-
retainAll
public boolean retainAll(Collection c)
Description copied from class:List
Method to retain a Collection of elements (and remove all others).
-
set
public E set(int index, E element, boolean allowDependentField)
Description copied from class:List
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.
-
set
public E set(int index, E element)
Description copied from class:List
Method to set the element at a position in the ArrayList.
-
writeReplace
protected Object writeReplace() throws ObjectStreamException
Description copied from class:List
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.- Overrides:
writeReplace
in classList<E>
- Returns:
- the replaced object
- Throws:
ObjectStreamException
- if an error occurs
-
spliterator
public Spliterator spliterator()
- Specified by:
spliterator
in interfaceCollection<E>
- Specified by:
spliterator
in interfaceIterable<E>
- Specified by:
spliterator
in interfaceList<E>
- Overrides:
spliterator
in classList<E>
-
stream
public Stream stream()
-
parallelStream
public Stream parallelStream()
- Specified by:
parallelStream
in interfaceCollection<E>
- Overrides:
parallelStream
in classList<E>
-
-