Class SortedSet<E>

java.lang.Object
java.util.AbstractCollection<E>
java.util.AbstractSet<E>
org.datanucleus.store.types.wrappers.SortedSet<E>
All Implemented Interfaces:
Serializable, Cloneable, Iterable<E>, Collection<E>, Set<E>, SortedSet<E>, SCO<SortedSet<E>>, SCOCollection<SortedSet<E>, E>, SCOContainer<SortedSet<E>>
Direct Known Subclasses:
SortedSet
public class SortedSet<E> extends AbstractSet<E> implements SortedSet<E>, SCOCollection<SortedSet<E>, E>, Cloneable, Serializable
A mutable second-class SortedSet 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:

  • Field Details

  • Constructor Details

    • SortedSet

      public SortedSet(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 Details

    • initialise

      public void initialise(SortedSet<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 interface SCO<E>
      Parameters:
      newValue - New value (to wrap)
      oldValue - Old value (to use in deciding what needs deleting etc)

    • initialise

      public void initialise(SortedSet<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>

    • initialiseDelegate

      protected void initialiseDelegate()
      Convenience method to set up the delegate respecting any comparator specified in MetaData.

    • getValue

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

    • getOwner

      public 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 SortedSet<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 interface SCO<E>
      Parameters:
      state - State for detachment process
      Returns:
      The detached container

    • attachCopy

      public void attachCopy(SortedSet<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 interface SCO<E>
      Parameters:
      value - The new (collection) value

    • clone

      public Object clone()
      Creates and returns a copy of this object.
      Specified by:
      clone in interface SCO<E>
      Overrides:
      clone in class Object
      Returns:
      The cloned object

    • comparator

      public Comparator<? super E> comparator()
      Accessor for the comparator.
      Specified by:
      comparator in interface SortedSet<E>
      Returns:
      The comparator

    • contains

      public boolean contains(Object element)
      Accessor for whether an element is contained in this Set.
      Specified by:
      contains in interface Collection<E>
      Specified by:
      contains in interface Set<E>
      Overrides:
      contains in class AbstractCollection<E>
      Parameters:
      element - The element
      Returns:
      Whether it is contained.

    • containsAll

      public boolean containsAll(Collection<?> c)
      Accessor for whether a collection is contained in this Set.
      Specified by:
      containsAll in interface Collection<E>
      Specified by:
      containsAll in interface Set<E>
      Overrides:
      containsAll in class AbstractCollection<E>
      Parameters:
      c - The collection
      Returns:
      Whether it is contained.

    • equals

      public boolean equals(Object o)
      Equality operator.
      Specified by:
      equals in interface Collection<E>
      Specified by:
      equals in interface Set<E>
      Overrides:
      equals in class AbstractSet<E>
      Parameters:
      o - The object to compare against.
      Returns:
      Whether this object is the same.

    • first

      public E first()
      Accessor for the first element in the sorted set.
      Specified by:
      first in interface SortedSet<E>
      Returns:
      The first element

    • hashCode

      public int hashCode()
      Hashcode operator.
      Specified by:
      hashCode in interface Collection<E>
      Specified by:
      hashCode in interface Set<E>
      Overrides:
      hashCode in class AbstractSet<E>
      Returns:
      The Hash code.

    • isEmpty

      public boolean isEmpty()
      Accessor for whether the SortedSet is empty.
      Specified by:
      isEmpty in interface Collection<E>
      Specified by:
      isEmpty in interface Set<E>
      Overrides:
      isEmpty in class AbstractCollection<E>
      Returns:
      Whether it is empty.

    • iterator

      public Iterator<E> iterator()
      Accessor for an iterator for the Set.
      Specified by:
      iterator in interface Collection<E>
      Specified by:
      iterator in interface Iterable<E>
      Specified by:
      iterator in interface Set<E>
      Specified by:
      iterator in class AbstractCollection<E>
      Returns:
      The iterator

    • headSet

      public SortedSet<E> headSet(E toElement)
      Method to retrieve the head elements up to the specified element.
      Specified by:
      headSet in interface SortedSet<E>
      Parameters:
      toElement - the element to return up to.
      Returns:
      The set of elements meeting the input

    • subSet

      public SortedSet<E> subSet(E fromElement, E toElement)
      Method to retrieve the subset of elements between the specified elements.
      Specified by:
      subSet in interface SortedSet<E>
      Parameters:
      fromElement - The start element
      toElement - The end element
      Returns:
      The set of elements meeting the input

    • tailSet

      public SortedSet<E> tailSet(E fromElement)
      Method to retrieve the set of elements after the specified element.
      Specified by:
      tailSet in interface SortedSet<E>
      Parameters:
      fromElement - The start element
      Returns:
      The set of elements meeting the input

    • last

      public E last()
      Accessor for the last element in the sorted set.
      Specified by:
      last in interface SortedSet<E>
      Returns:
      The last element

    • size

      public int size()
      Accessor for the size of the SortedSet.
      Specified by:
      size in interface Collection<E>
      Specified by:
      size in interface Set<E>
      Specified by:
      size in class AbstractCollection<E>
      Returns:
      The size.

    • toArray

      public Object[] toArray()
      Specified by:
      toArray in interface Collection<E>
      Specified by:
      toArray in interface Set<E>
      Overrides:
      toArray in class AbstractCollection<E>

    • toArray

      public <T> T[] toArray(T[] a)
      Specified by:
      toArray in interface Collection<E>
      Specified by:
      toArray in interface Set<E>
      Overrides:
      toArray in class AbstractCollection<E>

    • add

      public boolean add(E element)
      Method to add an element to the SortedSet.
      Specified by:
      add in interface Collection<E>
      Specified by:
      add in interface Set<E>
      Overrides:
      add in class AbstractCollection<E>
      Parameters:
      element - The new element
      Returns:
      Whether it was added ok.

    • addAll

      public boolean addAll(Collection<? extends E> elements)
      Method to add a collection to the SortedSet.
      Specified by:
      addAll in interface Collection<E>
      Specified by:
      addAll in interface Set<E>
      Overrides:
      addAll in class AbstractCollection<E>
      Parameters:
      elements - The collection
      Returns:
      Whether it was added ok.

    • clear

      public void clear()
      Method to clear the SortedSet
      Specified by:
      clear in interface Collection<E>
      Specified by:
      clear in interface Set<E>
      Overrides:
      clear in class AbstractCollection<E>

    • remove

      public boolean remove(Object element)
      Method to remove (the first occurrence of) an element from the collection
      Specified by:
      remove in interface Collection<E>
      Specified by:
      remove in interface Set<E>
      Overrides:
      remove in class AbstractCollection<E>
      Parameters:
      element - The Element to remove
      Returns:
      Whether it was removed successfully.

    • remove

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

    • removeAll

      public boolean removeAll(Collection<?> elements)
      Method to remove all elements from the collection from the SortedSet.
      Specified by:
      removeAll in interface Collection<E>
      Specified by:
      removeAll in interface Set<E>
      Overrides:
      removeAll in class AbstractSet<E>
      Parameters:
      elements - The collection of elements to remove
      Returns:
      Whether it was removed ok.

    • retainAll

      public boolean retainAll(Collection<?> c)
      Method to retain a Collection of elements (and remove all others).
      Specified by:
      retainAll in interface Collection<E>
      Specified by:
      retainAll in interface Set<E>
      Overrides:
      retainAll in class AbstractCollection<E>
      Parameters:
      c - The collection to retain
      Returns:
      Whether they were retained successfully.

    • 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

    • forEach

      public void forEach(Consumer<? super E> action)
      Specified by:
      forEach in interface Iterable<E>

    • stream

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

    • parallelStream

      public Stream<E> parallelStream()
      Specified by:
      parallelStream in interface Collection<E>

    • spliterator

      public Spliterator<E> spliterator()
      Specified by:
      spliterator in interface Collection<E>
      Specified by:
      spliterator in interface Iterable<E>
      Specified by:
      spliterator in interface Set<E>
      Specified by:
      spliterator in interface SortedSet<E>