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

Class 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>>, BackedSCO
    public class PriorityQueue<E>
extends PriorityQueue<E>
implements BackedSCO
    A mutable second-class PriorityQueue object. This class extends PriorityQueue, 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
      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 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.
      boolean equals​(java.lang.Object o)  
      void forEach​(java.util.function.Consumer<? super E> action)  
      Store getBackingStore()  
      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.
      void initialise​(java.util.PriorityQueue<E> c)
      Method to initialise the SCO from an existing 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.
      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.
      protected void loadFromStore()
      Method to load all elements from the "backing store" where appropriate.
      boolean 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 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.
      boolean retainAll​(java.util.Collection c)
      Method to retain a Collection of elements (and remove all others).
      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.

      • Methods inherited from class java.util.PriorityQueue

        spliterator

      • Methods inherited from class java.util.AbstractQueue

        element, remove

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.util.Collection

        removeIf

    • 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

    • 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 interface SCO<E>
        Overrides:
        initialise in class PriorityQueue<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)
        Method to initialise the SCO from an existing value.
        Specified by:
        initialise in interface SCO<E>
        Overrides:
        initialise in class PriorityQueue<E>
        Parameters:
        c - The object to set from

      • getValue

        public java.util.PriorityQueue<E> getValue()
        Accessor for the unwrapped value that we are wrapping.
        Specified by:
        getValue in interface SCO<E>
        Overrides:
        getValue in class PriorityQueue<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 PriorityQueue<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 PriorityQueue<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 collection.
        Specified by:
        updateEmbeddedElement in interface SCOCollection<java.util.PriorityQueue<E>,​E>
        Overrides:
        updateEmbeddedElement in class PriorityQueue<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.

      • 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.

        Specified by:
        clone in interface SCO<E>
        Overrides:
        clone in class PriorityQueue<E>
        Returns:
        A clone of the object

      • comparator

        public java.util.Comparator comparator()
        Description copied from class: PriorityQueue
        Accessor for the comparator.
        Overrides:
        comparator in class PriorityQueue<E>
        Returns:
        The comparator

      • contains

        public boolean contains​(java.lang.Object element)
        Description copied from class: PriorityQueue
        Accessor for whether an element is contained in the Collection.
        Specified by:
        contains in interface java.util.Collection<E>
        Overrides:
        contains in class PriorityQueue<E>
        Parameters:
        element - The element
        Returns:
        Whether the element is contained here

      • containsAll

        public boolean containsAll​(java.util.Collection c)
        Description copied from class: PriorityQueue
        Accessor for whether a collection of elements are contained here.
        Specified by:
        containsAll in interface java.util.Collection<E>
        Overrides:
        containsAll in class PriorityQueue<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>
        Overrides:
        equals in class PriorityQueue<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 PriorityQueue<E>

      • hashCode

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

      • isEmpty

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

      • iterator

        public java.util.Iterator<E> iterator()
        Description copied from class: PriorityQueue
        Accessor for an iterator for the Collection.
        Specified by:
        iterator in interface java.util.Collection<E>
        Specified by:
        iterator in interface java.lang.Iterable<E>
        Overrides:
        iterator in class PriorityQueue<E>
        Returns:
        The iterator

      • peek

        public E peek()
        Description copied from class: PriorityQueue
        Method to peek at the next element in the Queue.
        Specified by:
        peek in interface java.util.Queue<E>
        Overrides:
        peek in class PriorityQueue<E>
        Returns:
        The element

      • size

        public int size()
        Description copied from class: PriorityQueue
        Accessor for the size of the Collection.
        Specified by:
        size in interface java.util.Collection<E>
        Overrides:
        size in class PriorityQueue<E>
        Returns:
        The size

      • toArray

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

      • toArray

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

      • toString

        public java.lang.String toString()
        Description copied from class: PriorityQueue
        Method to return the Collection as a String.
        Overrides:
        toString in class PriorityQueue<E>
        Returns:
        The string form

      • add

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

      • addAll

        public boolean addAll​(java.util.Collection<? extends E> elements)
        Description copied from class: PriorityQueue
        Method to add a collection of elements.
        Specified by:
        addAll in interface java.util.Collection<E>
        Overrides:
        addAll in class PriorityQueue<E>
        Parameters:
        elements - The collection of elements to add.
        Returns:
        Whether they were added successfully.

      • clear

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

      • offer

        public boolean offer​(E element)
        Description copied from class: PriorityQueue
        Method to offer an element to the Queue.
        Specified by:
        offer in interface java.util.Queue<E>
        Overrides:
        offer in class PriorityQueue<E>
        Parameters:
        element - The element to offer
        Returns:
        Whether it was added successfully.

      • poll

        public E poll()
        Description copied from class: PriorityQueue
        Method to poll the next element in the Queue.
        Specified by:
        poll in interface java.util.Queue<E>
        Overrides:
        poll in class PriorityQueue<E>
        Returns:
        The element (now removed)

      • remove

        public boolean remove​(java.lang.Object element)
        Description copied from class: PriorityQueue
        Method to remove (the first occurrence of) an element from the collection
        Specified by:
        remove in interface java.util.Collection<E>
        Overrides:
        remove in class PriorityQueue<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: PriorityQueue
        Method to remove (the first occurrence of) an element from the collection
        Specified by:
        remove in interface SCOCollection<java.util.PriorityQueue<E>,​E>
        Overrides:
        remove in class PriorityQueue<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)
        Description copied from class: PriorityQueue
        Method to remove a Collection of elements.
        Specified by:
        removeAll in interface java.util.Collection<E>
        Overrides:
        removeAll in class PriorityQueue<E>
        Parameters:
        elements - The collection to remove
        Returns:
        Whether they were removed successfully.

      • retainAll

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

      • writeReplace

        protected java.lang.Object writeReplace()
                                 throws java.io.ObjectStreamException
        Description copied from class: PriorityQueue
        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 PriorityQueue<E>
        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>
        Overrides:
        stream in class PriorityQueue<E>

      • parallelStream

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