Package org.datanucleus.store.types.wrappers

Class Stack<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.Stack<E>>, SCOCollection<java.util.Stack<E>,​E>, SCOContainer<java.util.Stack<E>>, SCOList<java.util.Stack<E>,​E>
    Direct Known Subclasses:
    Stack
    public class Stack<E>
extends java.util.Stack<E>
implements SCOList<java.util.Stack<E>,​E>
    A mutable second-class Stack 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

    • 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 Stack
      boolean add​(E element)
      Method to add an element to the Stack
      boolean addAll​(int index, java.util.Collection<? extends E> elements)
      Method to add a Collection to a position in the Stack
      boolean addAll​(java.util.Collection<? extends E> elements)
      Method to add a Collection to the Stack
      void addElement​(E element)
      Method to add an element to the Stack
      void attachCopy​(java.util.Stack value)
      Method to return an attached copy of the passed (detached) value.
      void clear()
      Method to clear the Stack
      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.
      java.util.Stack detachCopy​(FetchPlanState state)
      Method to return a detached copy of the container.
      boolean empty()
      Accessor for whether the Stack is empty.
      void ensureCapacity​(int minCapacity)  
      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.
      java.lang.String getFieldName()
      Accessor for the field name.
      java.lang.Object getOwner()
      Accessor for the owner object.
      java.util.Stack<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, and allowing the SCO to be loaded from the datastore (when we have a backing store).
      void initialise​(java.util.Stack<E> c)
      Method to initialise the SCO for use with the provided initial value.
      void initialise​(java.util.Stack<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 Stack 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.
      void makeDirty()
      Utility to mark the object as dirty
      java.util.stream.Stream<E> parallelStream()  
      E peek()
      Method to retrieve the element at the top of the stack.
      E pop()
      Method to remove the top element in the stack and return it.
      E push​(E element)
      Method to push an element onto the stack and return it.
      E remove​(int index)
      Method to remove an element from the Stack
      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 objects from the Stack
      void removeAllElements()
      Method to remove all elements from the Stack.
      boolean removeElement​(java.lang.Object element)
      Method to remove an element from the Stack
      void removeElementAt​(int index)
      Method to remove an element from the Stack
      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 Stack
      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 setElementAt​(E element, int index)
      Method to set the element at a position in the Stack
      void setValue​(java.util.Stack<E> value)
      Method to change the delegate value this wraps (to save recreating the wrapper).
      int size()
      Accessor for the size of the Stack.
      void sort​(java.util.Comparator<? super E> comp)  
      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 trimToSize()  
      void unsetOwner()
      Method to unset the owner and field information.
      void updateEmbeddedElement​(E element, int fieldNumber, java.lang.Object value, boolean makeDirty)
      Method to update an embedded element in this collection.
      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.Stack

        search

      • Methods inherited from class java.util.Vector

        capacity, containsAll, copyInto, elementAt, elements, firstElement, indexOf, insertElementAt, lastElement, lastIndexOf, removeIf, removeRange, replaceAll, setSize, toString

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • delegate

        protected java.util.Stack<E> delegate
        The internal "delegate".

      • sorting

        protected boolean sorting

    • Constructor Detail

      • Stack

        public Stack​(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.Stack<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>
        Parameters:
        newValue - New value (to wrap)
        oldValue - Old value (to use in deciding what needs deleting etc)

      • initialise

        public void initialise​(java.util.Stack<E> 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 java.util.Stack<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​(java.util.Stack<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,
                                  java.lang.Object value,
                                  boolean makeDirty)
        Method to update an embedded element in this collection.
        Specified by:
        updateEmbeddedElement in interface SCOCollection<java.util.Stack<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 java.lang.String getFieldName()
        Accessor for the field name.
        Specified by:
        getFieldName in interface SCO<E>
        Returns:
        The field name

      • getOwner

        public java.lang.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 java.util.Stack 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 of detachment state
        Returns:
        The detached container

      • attachCopy

        public void attachCopy​(java.util.Stack 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 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 java.util.Vector<E>
        Returns:
        The cloned object

      • contains

        public boolean contains​(java.lang.Object element)
        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 java.util.Vector<E>
        Parameters:
        element - The element
        Returns:
        Whether it is contained

      • empty

        public boolean empty()
        Accessor for whether the Stack is empty.
        Overrides:
        empty in class java.util.Stack<E>
        Returns:
        Whether it is empty.

      • 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 java.util.Vector<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 java.util.Vector<E>

      • get

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

      • indexOf

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

      • isEmpty

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

      • iterator

        public java.util.Iterator<E> iterator()
        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 java.util.Vector<E>
        Returns:
        The iterator

      • listIterator

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

      • listIterator

        public java.util.ListIterator<E> listIterator​(int index)
        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 java.util.Vector<E>
        Parameters:
        index - The start point
        Returns:
        The iterator

      • lastIndexOf

        public int lastIndexOf​(java.lang.Object element)
        Method to retrieve the last position of the element.
        Specified by:
        lastIndexOf in interface java.util.List<E>
        Overrides:
        lastIndexOf in class java.util.Vector<E>
        Parameters:
        element - The element
        Returns:
        The last position of this element in the List.

      • peek

        public E peek()
        Method to retrieve the element at the top of the stack.
        Overrides:
        peek in class java.util.Stack<E>
        Returns:
        The element at the top of the stack

      • size

        public int size()
        Accessor for the size of the Stack.
        Specified by:
        size in interface java.util.Collection<E>
        Specified by:
        size in interface java.util.List<E>
        Overrides:
        size in class java.util.Vector<E>
        Returns:
        The size.

      • subList

        public java.util.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 java.util.List<E>
        Overrides:
        subList in class java.util.Vector<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 java.util.Vector<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 java.util.Vector<E>

      • add

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

      • add

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

      • addElement

        public void addElement​(E element)
        Method to add an element to the Stack
        Overrides:
        addElement in class java.util.Vector<E>
        Parameters:
        element - The new element

      • addAll

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

      • addAll

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

      • clear

        public void clear()
        Method to clear the Stack
        Specified by:
        clear in interface java.util.Collection<E>
        Specified by:
        clear in interface java.util.List<E>
        Overrides:
        clear in class java.util.Vector<E>

      • pop

        public E pop()
        Method to remove the top element in the stack and return it.
        Overrides:
        pop in class java.util.Stack<E>
        Returns:
        The top element that was in the Stack (now removed).

      • push

        public E push​(E element)
        Method to push an element onto the stack and return it.
        Overrides:
        push in class java.util.Stack<E>
        Parameters:
        element - The element to push onto the stack.
        Returns:
        The element that was pushed onto the Stack

      • remove

        public boolean remove​(java.lang.Object element)
        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 java.util.Vector<E>
        Parameters:
        element - The Element to remove
        Returns:
        Whether it was removed successfully.

      • remove

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

      • removeAll

        public boolean removeAll​(java.util.Collection elements)
        Method to remove a Collection of objects from the Stack
        Specified by:
        removeAll in interface java.util.Collection<E>
        Specified by:
        removeAll in interface java.util.List<E>
        Overrides:
        removeAll in class java.util.Vector<E>
        Parameters:
        elements - The Collection
        Returns:
        Whether the collection of elements were removed

      • removeElement

        public boolean removeElement​(java.lang.Object element)
        Method to remove an element from the Stack
        Overrides:
        removeElement in class java.util.Vector<E>
        Parameters:
        element - The element
        Returns:
        Whether the element was removed

      • remove

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

      • removeElementAt

        public void removeElementAt​(int index)
        Method to remove an element from the Stack
        Overrides:
        removeElementAt in class java.util.Vector<E>
        Parameters:
        index - The element position.

      • removeAllElements

        public void removeAllElements()
        Method to remove all elements from the Stack. Same as clear().
        Overrides:
        removeAllElements in class java.util.Vector<E>

      • retainAll

        public boolean retainAll​(java.util.Collection c)
        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 java.util.Vector<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<java.util.Stack<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 Stack
        Specified by:
        set in interface java.util.List<E>
        Overrides:
        set in class java.util.Vector<E>
        Parameters:
        index - The position
        element - The new element
        Returns:
        The element previously at that position

      • setElementAt

        public void setElementAt​(E element,
                         int index)
        Method to set the element at a position in the Stack
        Overrides:
        setElementAt in class java.util.Vector<E>
        Parameters:
        element - The new element
        index - The position

      • writeReplace

        protected java.lang.Object writeReplace()
                                 throws java.io.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:
        java.io.ObjectStreamException - if an error occurs

      • stream

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

      • parallelStream

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

      • trimToSize

        public void trimToSize()
        Overrides:
        trimToSize in class java.util.Vector<E>

      • ensureCapacity

        public void ensureCapacity​(int minCapacity)
        Overrides:
        ensureCapacity in class java.util.Vector<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 java.util.Vector<E>

      • 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 java.util.Vector<E>

      • sort

        public void sort​(java.util.Comparator<? super E> comp)
        Specified by:
        sort in interface java.util.List<E>
        Overrides:
        sort in class java.util.Vector<E>