Class PriorityQueue<E>
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractQueue<E>
-
- java.util.PriorityQueue<E>
-
- org.datanucleus.store.types.wrappers.PriorityQueue<E>
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.lang.Iterable<E>
,java.util.Collection<E>
,java.util.Queue<E>
,SCO<java.util.PriorityQueue<E>>
,SCOCollection<java.util.PriorityQueue<E>,E>
,SCOContainer<java.util.PriorityQueue<E>>
- Direct Known Subclasses:
PriorityQueue
public class PriorityQueue<E> extends java.util.PriorityQueue<E> implements SCOCollection<java.util.PriorityQueue<E>,E>, java.lang.Cloneable
A mutable second-class PriorityQueue 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 java.util.PriorityQueue<E>
delegate
The internal "delegate".protected AbstractMemberMetaData
ownerMmd
protected DNStateManager
ownerSM
-
Constructor Summary
Constructors Constructor Description PriorityQueue(DNStateManager sm, AbstractMemberMetaData mmd)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
add(E element)
Method to add an element to the Collection.boolean
addAll(java.util.Collection<? extends E> elements)
Method to add a collection of elements.void
attachCopy(java.util.PriorityQueue<E> value)
Method to return an attached copy of the passed (detached) value.void
clear()
Method to clear the Collection.java.lang.Object
clone()
Creates and returns a copy of this object.java.util.Comparator
comparator()
Accessor for the comparator.boolean
contains(java.lang.Object element)
Accessor for whether an element is contained in the Collection.boolean
containsAll(java.util.Collection c)
Accessor for whether a collection of elements are contained here.java.util.PriorityQueue<E>
detachCopy(FetchPlanState state)
Method to return a detached copy of the container.boolean
equals(java.lang.Object o)
void
forEach(java.util.function.Consumer<? super E> action)
java.lang.String
getFieldName()
Accessor for the field name.java.lang.Object
getOwner()
Accessor for the owner object.java.util.PriorityQueue<E>
getValue()
Accessor for the unwrapped value that we are wrapping.int
hashCode()
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.PriorityQueue<E> c)
Method to initialise the SCO for use with the provided initial value.void
initialise(java.util.PriorityQueue<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.protected void
initialiseDelegate()
Convenience method to set up the delegate respecting any comparator specified in MetaData.boolean
isEmpty()
Accessor for whether the Collection is empty.boolean
isLoaded()
Method to return if the SCO has its contents loaded.java.util.Iterator<E>
iterator()
Accessor for an iterator for the Collection.void
load()
Method to effect the load of the data in the SCO.void
makeDirty()
Utility to mark the object as dirtyboolean
offer(E element)
Method to offer an element to the Queue.java.util.stream.Stream<E>
parallelStream()
E
peek()
Method to peek at the next element in the Queue.E
poll()
Method to poll the next element in the Queue.boolean
remove(java.lang.Object element)
Method to remove (the first occurrence of) an element from the collectionboolean
remove(java.lang.Object element, boolean allowCascadeDelete)
Method to remove (the first occurrence of) an element from the collectionboolean
removeAll(java.util.Collection<?> elements)
Method to remove a Collection of elements.boolean
retainAll(java.util.Collection c)
Method to retain a Collection of elements (and remove all others).void
setValue(java.util.PriorityQueue<E> value)
Method to change the delegate value this wraps (to save recreating the wrapper).int
size()
Accessor for the size of the Collection.java.util.stream.Stream<E>
stream()
java.lang.Object[]
toArray()
<T> T[]
toArray(T[] a)
java.lang.String
toString()
Method to return the Collection as a String.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.
-
-
-
Field Detail
-
ownerSM
protected DNStateManager ownerSM
-
ownerMmd
protected AbstractMemberMetaData ownerMmd
-
delegate
protected java.util.PriorityQueue<E> delegate
The internal "delegate".
-
-
Constructor Detail
-
PriorityQueue
public PriorityQueue(DNStateManager sm, AbstractMemberMetaData mmd)
Constructor.- Parameters:
sm
- StateManager for this set.mmd
- Metadata for the member
-
-
Method Detail
-
initialise
public void initialise(java.util.PriorityQueue<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 interfaceSCO<E>
- Parameters:
newValue
- New value (to wrap)oldValue
- Old value (to use in deciding what needs deleting etc)
-
initialise
public void initialise(java.util.PriorityQueue<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 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>
-
initialiseDelegate
protected void initialiseDelegate()
Convenience method to set up the delegate respecting any comparator specified in MetaData.
-
getValue
public java.util.PriorityQueue<E> getValue()
Accessor for the unwrapped value that we are wrapping.
-
setValue
public void setValue(java.util.PriorityQueue<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, java.lang.Object value, boolean makeDirty)
Method to update an embedded element in this collection.- Specified by:
updateEmbeddedElement
in interfaceSCOCollection<java.util.PriorityQueue<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 java.lang.String getFieldName()
Accessor for the field name.- Specified by:
getFieldName
in interfaceSCO<E>
- Returns:
- The field name
-
getOwner
public java.lang.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 java.util.PriorityQueue<E> detachCopy(FetchPlanState state)
Method to return a detached copy of the container. Recurses through the elements so that they are likewise detached.- Specified by:
detachCopy
in interfaceSCO<E>
- Parameters:
state
- State for detachment process- Returns:
- The detached container
-
attachCopy
public void attachCopy(java.util.PriorityQueue<E> 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 java.lang.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.
-
comparator
public java.util.Comparator comparator()
Accessor for the comparator.- Overrides:
comparator
in classjava.util.PriorityQueue<E>
- Returns:
- The comparator
-
contains
public boolean contains(java.lang.Object element)
Accessor for whether an element is contained in the Collection.
-
containsAll
public boolean containsAll(java.util.Collection c)
Accessor for whether a collection of elements are contained here.
-
equals
public boolean equals(java.lang.Object o)
- Specified by:
equals
in interfacejava.util.Collection<E>
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacejava.util.Collection<E>
- Overrides:
hashCode
in classjava.lang.Object
-
isEmpty
public boolean isEmpty()
Accessor for whether the Collection is empty.
-
iterator
public java.util.Iterator<E> iterator()
Accessor for an iterator for the Collection.
-
peek
public E peek()
Method to peek at the next element in the Queue.
-
size
public int size()
Accessor for the size of the Collection.
-
toArray
public java.lang.Object[] toArray()
-
toArray
public <T> T[] toArray(T[] a)
-
toString
public java.lang.String toString()
Method to return the Collection as a String.- Overrides:
toString
in classjava.util.AbstractCollection<E>
- Returns:
- The string form
-
add
public boolean add(E element)
Method to add an element to the Collection.
-
addAll
public boolean addAll(java.util.Collection<? extends E> elements)
Method to add a collection of elements.
-
clear
public void clear()
Method to clear the Collection.
-
offer
public boolean offer(E element)
Method to offer an element to the Queue.
-
poll
public E poll()
Method to poll the next element in the Queue.
-
remove
public boolean remove(java.lang.Object element)
Method to remove (the first occurrence of) an element from the collection
-
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 interfaceSCOCollection<java.util.PriorityQueue<E>,E>
- Parameters:
element
- The Element to removeallowCascadeDelete
- Whether to cascade delete- Returns:
- Whether it was removed successfully.
-
removeAll
public boolean removeAll(java.util.Collection<?> elements)
Method to remove a Collection of elements.
-
retainAll
public boolean retainAll(java.util.Collection c)
Method to retain a Collection of elements (and remove all others).
-
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
-
forEach
public void forEach(java.util.function.Consumer<? super E> action)
- Specified by:
forEach
in interfacejava.lang.Iterable<E>
-
stream
public java.util.stream.Stream<E> stream()
- Specified by:
stream
in interfacejava.util.Collection<E>
-
-