Class Stack<E>
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractList<E>
-
- java.util.Vector<E>
-
- java.util.Stack<E>
-
- org.datanucleus.store.types.wrappers.Stack<E>
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Iterable<E>
,Collection<E>
,List<E>
,RandomAccess
,SCO<Stack<E>>
,SCOCollection<Stack<E>,E>
,SCOContainer<Stack<E>>
,SCOList<Stack<E>,E>
- Direct Known Subclasses:
Stack
public class Stack<E> extends Stack<E> implements SCOList<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
-
-
Field Summary
Fields Modifier and Type Field Description protected Stack<E>
delegate
The internal "delegate".protected AbstractMemberMetaData
ownerMmd
protected ObjectProvider
ownerOP
protected boolean
sorting
-
Fields inherited from class java.util.Vector
capacityIncrement, elementCount, elementData
-
Fields inherited from class java.util.AbstractList
modCount
-
-
Constructor Summary
Constructors Constructor Description Stack(ObjectProvider ownerOP, AbstractMemberMetaData mmd)
Constructor, using the ObjectProvider 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 a position in the Stackboolean
add(E element)
Method to add an element to the Stackboolean
addAll(int index, Collection elements)
Method to add a Collection to a position in the Stackboolean
addAll(Collection elements)
Method to add a Collection to the Stackvoid
addElement(E element)
Method to add an element to the Stackvoid
attachCopy(Stack value)
Method to return an attached copy of the passed (detached) value.void
clear()
Method to clear the StackObject
clone()
Clone operator to return a copy of this object.boolean
contains(Object element)
Method to return if the list contains this element.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(Object o)
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.Stack<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(Stack c)
Method to initialise the SCO for use with the provided initial value.void
initialise(Stack<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 Stack is empty.boolean
isLoaded()
Method to return if the SCO has its contents loaded.Iterator
iterator()
Method to retrieve 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 dirtyjava.util.stream.Stream
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 Stackboolean
remove(Object element)
Method to remove an element from the Listboolean
remove(Object element, boolean allowCascadeDelete)
Method to remove an element from the Listboolean
removeAll(Collection elements)
Method to remove a Collection of objects from the Stackvoid
removeAllElements()
Method to remove all elements from the Stack.boolean
removeElement(Object element)
Method to remove an element from the Stackvoid
removeElementAt(int index)
Method to remove an element from the Stackboolean
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 StackE
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 Stackvoid
setValue(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(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 ListObject[]
toArray()
Method to return the list as an array.Object[]
toArray(Object[] a)
Method to return the list as an array.void
trimToSize()
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.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
-
Methods inherited from interface java.util.Collection
toArray
-
-
-
-
Field Detail
-
ownerOP
protected transient ObjectProvider ownerOP
-
ownerMmd
protected transient AbstractMemberMetaData ownerMmd
-
sorting
protected boolean sorting
-
-
Constructor Detail
-
Stack
public Stack(ObjectProvider ownerOP, AbstractMemberMetaData mmd)
Constructor, using the ObjectProvider of the "owner" and the field name.- Parameters:
ownerOP
- The owner ObjectProvidermmd
- Metadata for the member
-
-
Method Detail
-
initialise
public void initialise(Stack<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 interfaceSCO<E>
- Parameters:
newValue
- New value (to wrap)oldValue
- Old value (to use in deciding what needs deleting etc)
-
initialise
public void initialise(Stack 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 interfaceSCO<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 interfaceSCO<E>
-
setValue
public void setValue(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 interfaceSCOContainer<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 interfaceSCOContainer<E>
-
isLoaded
public boolean isLoaded()
Method to return if the SCO has its contents loaded. Returns true.- Specified by:
isLoaded
in interfaceSCOContainer<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 interfaceSCOCollection<Stack<E>,E>
- Parameters:
element
- The elementfieldNumber
- Number of field in the elementvalue
- New value for this fieldmakeDirty
- Whether to make the SCO field dirty.
-
getFieldName
public String getFieldName()
Accessor for the field name.- Specified by:
getFieldName
in interfaceSCO<E>
- Returns:
- The field name
-
getOwner
public Object getOwner()
Accessor for the owner object.
-
unsetOwner
public void unsetOwner()
Method to unset the owner and field information.- Specified by:
unsetOwner
in interfaceSCO<E>
-
makeDirty
public void makeDirty()
Utility to mark the object as dirty
-
detachCopy
public 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 interfaceSCO<E>
- Parameters:
state
- State of detachment state- Returns:
- The detached container
-
attachCopy
public void attachCopy(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 interfaceSCO<E>
- Parameters:
value
- The new (collection) value
-
clone
public 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.
-
contains
public boolean contains(Object element)
Method to return if the list contains this element.
-
empty
public boolean empty()
Accessor for whether the Stack is empty.
-
equals
public boolean equals(Object o)
-
hashCode
public int hashCode()
-
get
public E get(int index)
Method to retrieve an element no.
-
indexOf
public int indexOf(Object element)
Method to the position of an element.
-
isEmpty
public boolean isEmpty()
Accessor for whether the Stack is empty.
-
iterator
public Iterator iterator()
Method to retrieve an iterator for the list.
-
listIterator
public ListIterator listIterator()
Method to retrieve a List iterator for the list.- Specified by:
listIterator
in interfaceList<E>
- Overrides:
listIterator
in classVector<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 interfaceList<E>
- Overrides:
listIterator
in classVector<E>
- Parameters:
index
- The start point- Returns:
- The iterator
-
lastIndexOf
public int lastIndexOf(Object element)
Method to retrieve the last position of the element.- Specified by:
lastIndexOf
in interfaceList<E>
- Overrides:
lastIndexOf
in classVector<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.
-
size
public int size()
Accessor for the size of the Stack.
-
subList
public List<E> subList(int from, int to)
Accessor for the subList of elements between from and to of the List
-
toArray
public Object[] toArray()
Method to return the list as an array.
-
add
public void add(int index, E element)
Method to add an element to a position in the Stack
-
add
public boolean add(E element)
Method to add an element to the Stack
-
addElement
public void addElement(E element)
Method to add an element to the Stack- Overrides:
addElement
in classVector<E>
- Parameters:
element
- The new element
-
addAll
public boolean addAll(Collection elements)
Method to add a Collection to the Stack
-
addAll
public boolean addAll(int index, Collection elements)
Method to add a Collection to a position in the Stack
-
clear
public void clear()
Method to clear the Stack
-
pop
public E pop()
Method to remove the top element in the stack and return it.
-
remove
public boolean remove(Object element)
Method to remove an element from the List
-
remove
public boolean remove(Object element, boolean allowCascadeDelete)
Method to remove an element from the List- Specified by:
remove
in interfaceSCOCollection<Stack<E>,E>
- Parameters:
element
- The Element to removeallowCascadeDelete
- Whether to allow cascade delete- Returns:
- Whether it was removed successfully.
-
removeAll
public boolean removeAll(Collection elements)
Method to remove a Collection of objects from the Stack
-
removeElement
public boolean removeElement(Object element)
Method to remove an element from the Stack- Overrides:
removeElement
in classVector<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
-
removeElementAt
public void removeElementAt(int index)
Method to remove an element from the Stack- Overrides:
removeElementAt
in classVector<E>
- Parameters:
index
- The element position.
-
removeAllElements
public void removeAllElements()
Method to remove all elements from the Stack. Same as clear().- Overrides:
removeAllElements
in classVector<E>
-
retainAll
public boolean retainAll(Collection c)
Method to retain a Collection of elements (and remove all others).
-
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.
-
setElementAt
public void setElementAt(E element, int index)
Method to set the element at a position in the Stack- Overrides:
setElementAt
in classVector<E>
- Parameters:
element
- The new elementindex
- The 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 interfaceCollection<E>
-
parallelStream
public java.util.stream.Stream parallelStream()
- Specified by:
parallelStream
in interfaceCollection<E>
-
trimToSize
public void trimToSize()
- Overrides:
trimToSize
in classVector<E>
-
ensureCapacity
public void ensureCapacity(int minCapacity)
- Overrides:
ensureCapacity
in classVector<E>
-
forEach
public void forEach(java.util.function.Consumer action)
-
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 classVector<E>
-
-