Package org.datanucleus.store.types.wrappers.backed

Class ArrayList<E>

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, java.util.RandomAccess, SCO<java.util.ArrayList<E>>, SCOCollection<java.util.ArrayList<E>,​E>, SCOContainer<java.util.ArrayList<E>>, SCOList<java.util.ArrayList<E>,​E>, BackedSCO
    public class ArrayList<E>
extends ArrayList<E>
implements 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:
    Serialized Form

    • 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 a position in the ArrayList.
      boolean add​(E element)
      Method to add an element to the ArrayList.
      boolean addAll​(int index, java.util.Collection<? extends E> elements)
      Method to add a Collection to a position in the ArrayList.
      boolean addAll​(java.util.Collection<? extends E> elements)
      Method to add a Collection to the ArrayList.
      void clear()
      Method to clear the ArrayList.
      java.lang.Object clone()
      Clone operator to return a copy of this object.
      boolean contains​(java.lang.Object element)
      Method to return if the list contains this element.
      boolean containsAll​(java.util.Collection c)
      Accessor for whether a collection of elements are contained here.
      boolean equals​(java.lang.Object o)  
      void forEach​(java.util.function.Consumer<? super E> action)  
      E get​(int index)
      Method to retrieve an element no.
      Store getBackingStore()  
      java.util.ArrayList<E> getValue()
      Accessor for the unwrapped value that we are wrapping.
      int hashCode()  
      int indexOf​(java.lang.Object element)
      Method to the position of an element.
      void initialise()
      Method to initialise the SCO for use.
      void initialise​(java.util.ArrayList<E> c)
      Method to initialise the SCO from an existing value.
      void initialise​(java.util.ArrayList<E> newValue, java.lang.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.
      java.util.Iterator<E> iterator()
      Method to retrieve an iterator for the list.
      int lastIndexOf​(java.lang.Object element)
      Method to retrieve the last position of the element.
      java.util.ListIterator<E> listIterator()
      Method to retrieve a List iterator for the list.
      java.util.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.
      java.util.stream.Stream<E> parallelStream()  
      E remove​(int index)
      Method to remove an element from the ArrayList.
      boolean remove​(java.lang.Object element)
      Method to remove (the first occurrence of) an element from the collection
      boolean remove​(java.lang.Object element, boolean allowCascadeDelete)
      Method to remove (the first occurrence of) an element from the collection
      boolean removeAll​(java.util.Collection<?> elements)
      Method to remove a collection of elements from the List.
      boolean retainAll​(java.util.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 ArrayList.
      java.util.Spliterator<E> spliterator()  
      java.util.stream.Stream<E> stream()  
      java.util.List<E> subList​(int from, int to)
      Accessor for the subList of elements between from and to of the List
      java.lang.Object[] toArray()  
      <T> T[] toArray​(T[] a)  
      void unsetOwner()
      Method to unset the owner and backing store information.
      void updateEmbeddedElement​(E element, int fieldNumber, java.lang.Object value, boolean makeDirty)
      Method to update an embedded element in this list.
      protected java.lang.Object writeReplace()
      The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream.

      • Methods inherited from class java.util.ArrayList

        removeIf, removeRange, replaceAll

      • Methods inherited from class java.util.AbstractCollection

        toString

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • backingStore

        protected transient ListStore<E> backingStore

      • allowNulls

        protected transient boolean allowNulls

      • useCache

        protected transient boolean useCache

      • isCacheLoaded

        protected transient boolean isCacheLoaded

    • Constructor Detail

      • ArrayList

        public ArrayList​(DNStateManager sm,
                 AbstractMemberMetaData mmd)
        Constructor, using StateManager of the "owner" and the field name.
        Parameters:
        sm - The owner StateManager
        mmd - Metadata for the member

    • Method Detail

      • initialise

        public void initialise​(java.util.ArrayList<E> newValue,
                       java.lang.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>
        Overrides:
        initialise in class ArrayList<E>
        Parameters:
        newValue - New value (to wrap)
        oldValue - Old value (to use in deciding what needs deleting etc)

      • initialise

        public void initialise​(java.util.ArrayList<E> c)
        Method to initialise the SCO from an existing value.
        Specified by:
        initialise in interface SCO<E>
        Overrides:
        initialise in class ArrayList<E>
        Parameters:
        c - The object to set from

      • initialise

        public void initialise()
        Method to initialise the SCO for use.
        Specified by:
        initialise in interface SCO<E>
        Overrides:
        initialise in class ArrayList<E>

      • getValue

        public java.util.ArrayList<E> getValue()
        Accessor for the unwrapped value that we are wrapping.
        Specified by:
        getValue in interface SCO<E>
        Overrides:
        getValue in class ArrayList<E>
        Returns:
        The unwrapped 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>
        Overrides:
        load in class ArrayList<E>

      • 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.
        Specified by:
        isLoaded in interface BackedSCO
        Specified by:
        isLoaded in interface SCOContainer<E>
        Overrides:
        isLoaded in class ArrayList<E>
        Returns:
        Whether it is loaded

      • loadFromStore

        protected void loadFromStore()
        Method to load all elements from the "backing store" where appropriate.

      • updateEmbeddedElement

        public void updateEmbeddedElement​(E element,
                                  int fieldNumber,
                                  java.lang.Object value,
                                  boolean makeDirty)
        Method to update an embedded element in this list.
        Specified by:
        updateEmbeddedElement in interface SCOCollection<java.util.ArrayList<E>,​E>
        Overrides:
        updateEmbeddedElement in class ArrayList<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.

      • unsetOwner

        public void unsetOwner()
        Method to unset the owner and backing store information.
        Specified by:
        unsetOwner in interface SCO<E>
        Overrides:
        unsetOwner in class ArrayList<E>

      • clone

        public java.lang.Object 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.

        Specified by:
        clone in interface SCO<E>
        Overrides:
        clone in class ArrayList<E>
        Returns:
        The cloned object

      • contains

        public boolean contains​(java.lang.Object element)
        Description copied from class: ArrayList
        Method to return if the list contains this element.
        Specified by:
        contains in interface java.util.Collection<E>
        Specified by:
        contains in interface java.util.List<E>
        Overrides:
        contains in class ArrayList<E>
        Parameters:
        element - The element
        Returns:
        Whether it is contained

      • containsAll

        public boolean containsAll​(java.util.Collection c)
        Description copied from class: ArrayList
        Accessor for whether a collection of elements are contained here.
        Specified by:
        containsAll in interface java.util.Collection<E>
        Specified by:
        containsAll in interface java.util.List<E>
        Overrides:
        containsAll in class ArrayList<E>
        Parameters:
        c - The collection of elements.
        Returns:
        Whether they are contained.

      • equals

        public boolean equals​(java.lang.Object o)
        Specified by:
        equals in interface java.util.Collection<E>
        Specified by:
        equals in interface java.util.List<E>
        Overrides:
        equals in class ArrayList<E>

      • forEach

        public void forEach​(java.util.function.Consumer<? super E> action)
        Specified by:
        forEach in interface java.lang.Iterable<E>
        Overrides:
        forEach in class ArrayList<E>

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface java.util.Collection<E>
        Specified by:
        hashCode in interface java.util.List<E>
        Overrides:
        hashCode in class ArrayList<E>

      • get

        public E get​(int index)
        Description copied from class: ArrayList
        Method to retrieve an element no.
        Specified by:
        get in interface java.util.List<E>
        Overrides:
        get in class ArrayList<E>
        Parameters:
        index - The item to retrieve
        Returns:
        The element at that position.

      • indexOf

        public int indexOf​(java.lang.Object element)
        Description copied from class: ArrayList
        Method to the position of an element.
        Specified by:
        indexOf in interface java.util.List<E>
        Overrides:
        indexOf in class ArrayList<E>
        Parameters:
        element - The element.
        Returns:
        The position.

      • isEmpty

        public boolean isEmpty()
        Description copied from class: ArrayList
        Accessor for whether the ArrayList is empty.
        Specified by:
        isEmpty in interface java.util.Collection<E>
        Specified by:
        isEmpty in interface java.util.List<E>
        Overrides:
        isEmpty in class ArrayList<E>
        Returns:
        Whether it is empty.

      • iterator

        public java.util.Iterator<E> iterator()
        Description copied from class: ArrayList
        Method to retrieve an iterator for the list.
        Specified by:
        iterator in interface java.util.Collection<E>
        Specified by:
        iterator in interface java.lang.Iterable<E>
        Specified by:
        iterator in interface java.util.List<E>
        Overrides:
        iterator in class ArrayList<E>
        Returns:
        The iterator

      • listIterator

        public java.util.ListIterator<E> listIterator()
        Description copied from class: ArrayList
        Method to retrieve a List iterator for the list.
        Specified by:
        listIterator in interface java.util.List<E>
        Overrides:
        listIterator in class ArrayList<E>
        Returns:
        The iterator

      • listIterator

        public java.util.ListIterator<E> listIterator​(int index)
        Description copied from class: ArrayList
        Method to retrieve a List iterator for the list from the index.
        Specified by:
        listIterator in interface java.util.List<E>
        Overrides:
        listIterator in class ArrayList<E>
        Parameters:
        index - The start point
        Returns:
        The iterator

      • lastIndexOf

        public int lastIndexOf​(java.lang.Object element)
        Description copied from class: ArrayList
        Method to retrieve the last position of the element.
        Specified by:
        lastIndexOf in interface java.util.List<E>
        Overrides:
        lastIndexOf in class ArrayList<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.
        Specified by:
        size in interface java.util.Collection<E>
        Specified by:
        size in interface java.util.List<E>
        Overrides:
        size in class ArrayList<E>
        Returns:
        The size.

      • subList

        public java.util.List<E> subList​(int from,
                                 int to)
        Description copied from class: ArrayList
        Accessor for the subList of elements between from and to of the List
        Specified by:
        subList in interface java.util.List<E>
        Overrides:
        subList in class ArrayList<E>
        Parameters:
        from - Start index (inclusive)
        to - End index (exclusive)
        Returns:
        The subList

      • toArray

        public java.lang.Object[] toArray()
        Specified by:
        toArray in interface java.util.Collection<E>
        Specified by:
        toArray in interface java.util.List<E>
        Overrides:
        toArray in class ArrayList<E>

      • toArray

        public <T> T[] toArray​(T[] a)
        Specified by:
        toArray in interface java.util.Collection<E>
        Specified by:
        toArray in interface java.util.List<E>
        Overrides:
        toArray in class ArrayList<E>

      • add

        public void add​(int index,
                E element)
        Description copied from class: ArrayList
        Method to add an element to a position in the ArrayList.
        Specified by:
        add in interface java.util.List<E>
        Overrides:
        add in class ArrayList<E>
        Parameters:
        index - The position
        element - The new element

      • add

        public boolean add​(E element)
        Description copied from class: ArrayList
        Method to add an element to the ArrayList.
        Specified by:
        add in interface java.util.Collection<E>
        Specified by:
        add in interface java.util.List<E>
        Overrides:
        add in class ArrayList<E>
        Parameters:
        element - The new element
        Returns:
        Whether it was added ok.

      • addAll

        public boolean addAll​(java.util.Collection<? extends E> elements)
        Description copied from class: ArrayList
        Method to add a Collection to the ArrayList.
        Specified by:
        addAll in interface java.util.Collection<E>
        Specified by:
        addAll in interface java.util.List<E>
        Overrides:
        addAll in class ArrayList<E>
        Parameters:
        elements - The collection
        Returns:
        Whether it was added ok.

      • addAll

        public boolean addAll​(int index,
                      java.util.Collection<? extends E> elements)
        Description copied from class: ArrayList
        Method to add a Collection to a position in the ArrayList.
        Specified by:
        addAll in interface java.util.List<E>
        Overrides:
        addAll in class ArrayList<E>
        Parameters:
        index - Position to insert the collection.
        elements - The collection
        Returns:
        Whether it was added ok.

      • clear

        public void clear()
        Description copied from class: ArrayList
        Method to clear the ArrayList.
        Specified by:
        clear in interface java.util.Collection<E>
        Specified by:
        clear in interface java.util.List<E>
        Overrides:
        clear in class ArrayList<E>

      • remove

        public boolean remove​(java.lang.Object element)
        Description copied from class: ArrayList
        Method to remove (the first occurrence of) an element from the collection
        Specified by:
        remove in interface java.util.Collection<E>
        Specified by:
        remove in interface java.util.List<E>
        Overrides:
        remove in class ArrayList<E>
        Parameters:
        element - The Element to remove
        Returns:
        Whether it was removed successfully.

      • remove

        public boolean remove​(java.lang.Object element,
                      boolean allowCascadeDelete)
        Description copied from class: ArrayList
        Method to remove (the first occurrence of) an element from the collection
        Specified by:
        remove in interface SCOCollection<java.util.ArrayList<E>,​E>
        Overrides:
        remove in class ArrayList<E>
        Parameters:
        element - The Element to remove
        allowCascadeDelete - Whether to cascade delete
        Returns:
        Whether it was removed successfully.

      • remove

        public E remove​(int index)
        Description copied from class: ArrayList
        Method to remove an element from the ArrayList.
        Specified by:
        remove in interface java.util.List<E>
        Overrides:
        remove in class ArrayList<E>
        Parameters:
        index - The element position.
        Returns:
        The object that was removed

      • removeAll

        public boolean removeAll​(java.util.Collection<?> elements)
        Description copied from class: ArrayList
        Method to remove a collection of elements from the List.
        Specified by:
        removeAll in interface java.util.Collection<E>
        Specified by:
        removeAll in interface java.util.List<E>
        Overrides:
        removeAll in class ArrayList<E>
        Parameters:
        elements - Collection of elements to remove
        Returns:
        Whether it was successful.

      • retainAll

        public boolean retainAll​(java.util.Collection c)
        Description copied from class: ArrayList
        Method to retain a Collection of elements (and remove all others).
        Specified by:
        retainAll in interface java.util.Collection<E>
        Specified by:
        retainAll in interface java.util.List<E>
        Overrides:
        retainAll in class ArrayList<E>
        Parameters:
        c - The collection to retain
        Returns:
        Whether they were retained successfully.

      • set

        public E set​(int index,
             E element,
             boolean allowDependentField)
        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.
        Specified by:
        set in interface SCOList<java.util.ArrayList<E>,​E>
        Overrides:
        set in class ArrayList<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)
        Description copied from class: ArrayList
        Method to set the element at a position in the ArrayList.
        Specified by:
        set in interface java.util.List<E>
        Overrides:
        set in class ArrayList<E>
        Parameters:
        index - The position
        element - The new element
        Returns:
        The element previously at that position

      • writeReplace

        protected java.lang.Object writeReplace()
                                 throws java.io.ObjectStreamException
        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 class ArrayList<E>
        Returns:
        the replaced object
        Throws:
        java.io.ObjectStreamException - if an error occurs

      • spliterator

        public java.util.Spliterator<E> spliterator()
        Specified by:
        spliterator in interface java.util.Collection<E>
        Specified by:
        spliterator in interface java.lang.Iterable<E>
        Specified by:
        spliterator in interface java.util.List<E>
        Overrides:
        spliterator in class ArrayList<E>

      • stream

        public java.util.stream.Stream<E> stream()
        Specified by:
        stream in interface java.util.Collection<E>
        Overrides:
        stream in class ArrayList<E>

      • parallelStream

        public java.util.stream.Stream<E> parallelStream()
        Specified by:
        parallelStream in interface java.util.Collection<E>
        Overrides:
        parallelStream in class ArrayList<E>