Class ArrayList<E>
java.lang.Object
java.util.AbstractCollection<E>
java.util.AbstractList<E>
java.util.ArrayList<E>
org.datanucleus.store.types.wrappers.ArrayList<E>
org.datanucleus.store.types.wrappers.backed.ArrayList<E>
- All Implemented Interfaces:
Serializable
,Cloneable
,Iterable<E>
,Collection<E>
,List<E>
,RandomAccess
,SCO<ArrayList<E>>
,SCOCollection<ArrayList<E>,
,E> SCOContainer<ArrayList<E>>
,SCOList<ArrayList<E>,
,E> BackedSCO
A mutable second-class ArrayList object.
This class extends ArrayList, 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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
protected boolean
protected boolean
Fields inherited from class org.datanucleus.store.types.wrappers.ArrayList
delegate, ownerMmd, ownerSM, sorting
Fields inherited from class java.util.AbstractList
modCount
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor, using StateManager of the "owner" and the field name. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Method to add an element to a position in the ArrayList.boolean
Method to add an element to the ArrayList.boolean
addAll
(int index, Collection<? extends E> elements) Method to add a Collection to a position in the ArrayList.boolean
addAll
(Collection<? extends E> elements) Method to add a Collection to the ArrayList.void
clear()
Method to clear the ArrayList.clone()
Clone operator to return a copy of this object.boolean
Method to return if the list contains this element.boolean
Accessor for whether a collection of elements are contained here.boolean
void
get
(int index) Method to retrieve an element no.getValue()
Accessor for the unwrapped value that we are wrapping.int
hashCode()
int
Method to the position of an element.void
Method to initialise the SCO for use.void
initialise
(ArrayList<E> c) Method to initialise the SCO from an existing value.void
initialise
(ArrayList<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 ArrayList is empty.boolean
isLoaded()
Method to return if the SCO has its contents loaded.iterator()
Method to retrieve an iterator for the list.int
lastIndexOf
(Object element) Method to retrieve the last position of the element.Method to retrieve a List iterator for the list.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
Method to load all elements from the "backing store" where appropriate.remove
(int index) Method to remove an element from the ArrayList.boolean
Method to remove (the first occurrence of) an element from the collectionboolean
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
Method to retain a Collection of elements (and remove all others).Method to set the element at a position in the ArrayList.wrapper addition that allows turning off of the dependent-field checks when doing the position setting.int
size()
Accessor for the size of the ArrayList.stream()
subList
(int from, int to) Accessor for the subList of elements between from and to of the ListObject[]
toArray()
<T> T[]
toArray
(T[] a) void
Method to unset the owner and backing store information.void
updateEmbeddedElement
(E element, int fieldNumber, Object value, boolean makeDirty) Method to update an embedded element in this list.protected Object
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.ArrayList
attachCopy, detachCopy, ensureCapacity, getFieldName, getOwner, makeDirty, setValue, sort, trimToSize
Methods inherited from class java.util.ArrayList
removeIf, removeRange, replaceAll
Methods inherited from class java.util.AbstractCollection
toString
-
Field Details
-
backingStore
-
allowNulls
protected transient boolean allowNulls -
useCache
protected transient boolean useCache -
isCacheLoaded
protected transient boolean isCacheLoaded
-
-
Constructor Details
-
ArrayList
Constructor, using StateManager of the "owner" and the field name.- Parameters:
sm
- The owner StateManagermmd
- Metadata for the member
-
-
Method Details
-
initialise
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 classArrayList<E>
- Parameters:
newValue
- New value (to wrap)oldValue
- Old value (to use in deciding what needs deleting etc)
-
initialise
Method to initialise the SCO from an existing value.- Specified by:
initialise
in interfaceSCO<E>
- Overrides:
initialise
in classArrayList<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 classArrayList<E>
-
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
- Specified by:
getBackingStore
in interfaceBackedSCO
-
updateEmbeddedElement
Method to update an embedded element in this list.- Specified by:
updateEmbeddedElement
in interfaceSCOCollection<ArrayList<E>,
E> - Overrides:
updateEmbeddedElement
in classArrayList<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 backing store information.- Specified by:
unsetOwner
in interfaceSCO<E>
- Overrides:
unsetOwner
in classArrayList<E>
-
clone
Clone operator to return 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
Description copied from class:ArrayList
Method to return if the list contains this element. -
containsAll
Description copied from class:ArrayList
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 classArrayList<E>
- Parameters:
c
- The collection of elements.- Returns:
- Whether they are contained.
-
equals
-
forEach
-
hashCode
public int hashCode() -
get
Description copied from class:ArrayList
Method to retrieve an element no. -
indexOf
Description copied from class:ArrayList
Method to the position of an element. -
isEmpty
public boolean isEmpty()Description copied from class:ArrayList
Accessor for whether the ArrayList is empty. -
iterator
Description copied from class:ArrayList
Method to retrieve an iterator for the list. -
listIterator
Description copied from class:ArrayList
Method to retrieve a List iterator for the list.- Specified by:
listIterator
in interfaceList<E>
- Overrides:
listIterator
in classArrayList<E>
- Returns:
- The iterator
-
listIterator
Description copied from class:ArrayList
Method to retrieve a List iterator for the list from the index.- Specified by:
listIterator
in interfaceList<E>
- Overrides:
listIterator
in classArrayList<E>
- Parameters:
index
- The start point- Returns:
- The iterator
-
lastIndexOf
Description copied from class:ArrayList
Method to retrieve the last position of the element.- Specified by:
lastIndexOf
in interfaceList<E>
- Overrides:
lastIndexOf
in classArrayList<E>
- Parameters:
element
- The element- Returns:
- The last position of this element in the List.
-
size
public int size()Description copied from class:ArrayList
Accessor for the size of the ArrayList. -
subList
Description copied from class:ArrayList
Accessor for the subList of elements between from and to of the List -
toArray
-
toArray
public <T> T[] toArray(T[] a) -
add
Description copied from class:ArrayList
Method to add an element to a position in the ArrayList. -
add
Description copied from class:ArrayList
Method to add an element to the ArrayList. -
addAll
Description copied from class:ArrayList
Method to add a Collection to the ArrayList. -
addAll
Description copied from class:ArrayList
Method to add a Collection to a position in the ArrayList. -
clear
public void clear()Description copied from class:ArrayList
Method to clear the ArrayList. -
remove
Description copied from class:ArrayList
Method to remove (the first occurrence of) an element from the collection -
remove
Description copied from class:ArrayList
Method to remove (the first occurrence of) an element from the collection -
remove
Description copied from class:ArrayList
Method to remove an element from the ArrayList. -
removeAll
Description copied from class:ArrayList
Method to remove a collection of elements from the List. -
retainAll
Description copied from class:ArrayList
Method to retain a Collection of elements (and remove all others). -
set
Description copied from class:ArrayList
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
Description copied from class:ArrayList
Method to set the element at a position in the ArrayList. -
writeReplace
Description copied from class:ArrayList
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 classArrayList<E>
- Returns:
- the replaced object
- Throws:
ObjectStreamException
- if an error occurs
-
spliterator
- Specified by:
spliterator
in interfaceCollection<E>
- Specified by:
spliterator
in interfaceIterable<E>
- Specified by:
spliterator
in interfaceList<E>
- Overrides:
spliterator
in classArrayList<E>
-
stream
-
parallelStream
- Specified by:
parallelStream
in interfaceCollection<E>
- Overrides:
parallelStream
in classArrayList<E>
-