SortedSet (DataNucleus Core 5.2.3 API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractSet<E>
  - - org.datanucleus.store.types.wrappers.SortedSet<E>
    - - org.datanucleus.store.types.wrappers.backed.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>>, BackedSCO
```
public class SortedSet<E>
extends SortedSet<E>
implements BackedSCO
```
A mutable second-class SortedSet object. This class extends AbstractSet, using that class to contain the current objects, and the backing SetStore 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

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`allowNulls`
`protected SetStore<E>`	`backingStore`
`protected boolean`	`initialising`
`protected boolean`	`isCacheLoaded`
`protected boolean`	`useCache`

Fields inherited from class org.datanucleus.store.types.wrappers.SortedSet
delegate, ownerMmd, ownerOP

Constructor Summary

Constructors
Constructor and Description

SortedSet(ObjectProvider op, AbstractMemberMetaData mmd)
Constructor, using the ObjectProvider of the "owner" and the field name.

Constructors
Constructor and Description
`SortedSet(ObjectProvider op, 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 and Description
`boolean`	`add(E element)` Method to add an element to the SortedSet.
`boolean`	`addAll(Collection elements)` Method to add a collection to the SortedSet.
`void`	`clear()` Method to clear the SortedSet
`Object`	`clone()` Creates and returns a copy of this object.
`Comparator`	`comparator()` Accessor for the comparator.
`boolean`	`contains(Object element)` Accessor for whether an element is contained in this Set.
`boolean`	`containsAll(Collection c)` Accessor for whether a collection is contained in this Set.
`boolean`	`equals(Object o)` Equality operator.
`E`	`first()` Accessor for the first element in the sorted set.
`void`	`forEach(java.util.function.Consumer action)`
`Store`	`getBackingStore()`
`SortedSet`	`getValue()` Accessor for the unwrapped value that we are wrapping.
`int`	`hashCode()` Hashcode operator.
`SortedSet`	`headSet(E toElement)` Method to retrieve the head elements up to the specified element.
`void`	`initialise()` Method to initialise the SCO for use.
`void`	`initialise(SortedSet c)` Method to initialise the SCO from an existing value.
`void`	`initialise(SortedSet<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 SortedSet is empty.
`boolean`	`isLoaded()` Method to return if the SCO has its contents loaded.
`Iterator<E>`	`iterator()` Accessor for an iterator for the Set.
`E`	`last()` Accessor for the last element in the sorted set.
`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.
`java.util.stream.Stream`	`parallelStream()`
`boolean`	`remove(Object element)` Method to remove an element from the SortedSet.
`boolean`	`remove(Object element, boolean allowCascadeDelete)` Method to remove an element from the collection, and observe the flag for whether to allow cascade delete.
`boolean`	`removeAll(Collection elements)` Method to remove all elements from the collection from the SortedSet.
`boolean`	`retainAll(Collection c)` Method to retain a Collection of elements (and remove all others).
`int`	`size()` Accessor for the size of the SortedSet.
`Spliterator`	`spliterator()`
`java.util.stream.Stream`	`stream()`
`SortedSet`	`subSet(E fromElement, E toElement)` Method to retrieve the subset of elements between the specified elements.
`SortedSet`	`tailSet(E fromElement)` Method to retrieve the set of elements after the specified element.
`Object[]`	`toArray()` Method to return the list as an array.
`Object[]`	`toArray(Object[] a)` Method to return the list as an array.
`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 org.datanucleus.store.types.wrappers.SortedSet
attachCopy, detachCopy, getFieldName, getOwner, initialiseDelegate, makeDirty, setValue

Methods inherited from class java.util.AbstractCollection
toString

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 SetStore<E> backingStore
```
  - allowNulls
```
protected transient boolean allowNulls
```
  - useCache
```
protected transient boolean useCache
```
  - isCacheLoaded
```
protected transient boolean isCacheLoaded
```
  - initialising
```
protected transient boolean initialising
```
- Constructor Detail
  - SortedSet
```
public SortedSet(ObjectProvider op,
                 AbstractMemberMetaData mmd)
```
    Constructor, using the ObjectProvider of the "owner" and the field name.
    
    Parameters:
    
    op - The owner ObjectProvider
    
    mmd - Metadata for the member
- Method Detail
  - 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<SortedSet<E>>
    
    Overrides:
    
    initialise in class SortedSet<E>
    
    Parameters:
    
    newValue - New value (to wrap)
    
    oldValue - Old value (to use in deciding what needs deleting etc)
  - initialise
```
public void initialise(SortedSet c)
```
    Method to initialise the SCO from an existing value.
    
    Specified by:
    
    initialise in interface SCO<SortedSet<E>>
    
    Overrides:
    
    initialise in class SortedSet<E>
    
    Parameters:
    
    c - The object to set from
  - initialise
```
public void initialise()
```
    Method to initialise the SCO for use.
    
    Specified by:
    
    initialise in interface SCO<SortedSet<E>>
    
    Overrides:
    
    initialise in class SortedSet<E>
  - getValue
```
public SortedSet getValue()
```
    Accessor for the unwrapped value that we are wrapping.
    
    Specified by:
    
    getValue in interface SCO<SortedSet<E>>
    
    Overrides:
    
    getValue in class SortedSet<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<SortedSet<E>>
    
    Overrides:
    
    load in class SortedSet<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 SCOContainer<SortedSet<E>>
    
    Specified by:
    
    isLoaded in interface BackedSCO
    
    Overrides:
    
    isLoaded in class SortedSet<E>
    
    Returns:
    
    Whether it is loaded
  - loadFromStore
```
protected void loadFromStore()
```
    Method to load all elements from the "backing store" where appropriate.
  - getBackingStore
```
public Store getBackingStore()
```
    Specified by:
    
    getBackingStore in interface BackedSCO
  - 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>
    
    Overrides:
    
    updateEmbeddedElement in class SortedSet<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.
  - unsetOwner
```
public void unsetOwner()
```
    Method to unset the owner and field information.
    
    Specified by:
    
    unsetOwner in interface SCO<SortedSet<E>>
    
    Overrides:
    
    unsetOwner in class SortedSet<E>
  - clone
```
public Object clone()
```
    Creates and returns a copy of this object.
    
    Specified by:
    
    clone in interface SCO<SortedSet<E>>
    
    Overrides:
    
    clone in class SortedSet<E>
    
    Returns:
    
    The cloned object
  - comparator
```
public Comparator comparator()
```
    Accessor for the comparator.
    
    Specified by:
    
    comparator in interface SortedSet<E>
    
    Overrides:
    
    comparator in class 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 SortedSet<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 SortedSet<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 SortedSet<E>
    
    Parameters:
    
    o - The object to compare against.
    
    Returns:
    
    Whether this object is the same.
  - forEach
```
public void forEach(java.util.function.Consumer action)
```
    Specified by:
    
    forEach in interface Iterable<E>
    
    Overrides:
    
    forEach in class SortedSet<E>
  - first
```
public E first()
```
    Accessor for the first element in the sorted set.
    
    Specified by:
    
    first in interface SortedSet<E>
    
    Overrides:
    
    first in class 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 SortedSet<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 SortedSet<E>
    
    Returns:
    
    Whether it is empty.
  - iterator
```
public Iterator<E> iterator()
```
    Accessor for an iterator for the Set.
    
    Specified by:
    
    iterator in interface Iterable<E>
    
    Specified by:
    
    iterator in interface Collection<E>
    
    Specified by:
    
    iterator in interface Set<E>
    
    Overrides:
    
    iterator in class SortedSet<E>
    
    Returns:
    
    The iterator
  - headSet
```
public SortedSet headSet(E toElement)
```
    Method to retrieve the head elements up to the specified element.
    
    Specified by:
    
    headSet in interface SortedSet<E>
    
    Overrides:
    
    headSet in class SortedSet<E>
    
    Parameters:
    
    toElement - the element to return up to.
    
    Returns:
    
    The set of elements meeting the input
  - subSet
```
public SortedSet subSet(E fromElement,
                        E toElement)
```
    Method to retrieve the subset of elements between the specified elements.
    
    Specified by:
    
    subSet in interface SortedSet<E>
    
    Overrides:
    
    subSet in class SortedSet<E>
    
    Parameters:
    
    fromElement - The start element
    
    toElement - The end element
    
    Returns:
    
    The set of elements meeting the input
  - tailSet
```
public SortedSet tailSet(E fromElement)
```
    Method to retrieve the set of elements after the specified element.
    
    Specified by:
    
    tailSet in interface SortedSet<E>
    
    Overrides:
    
    tailSet in class 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>
    
    Overrides:
    
    last in class 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>
    
    Overrides:
    
    size in class SortedSet<E>
    
    Returns:
    
    The size.
  - toArray
```
public Object[] toArray()
```
    Method to return the list as an array.
    
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface Set<E>
    
    Overrides:
    
    toArray in class SortedSet<E>
    
    Returns:
    
    The array
  - toArray
```
public Object[] toArray(Object[] a)
```
    Method to return the list as an array.
    
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface Set<E>
    
    Overrides:
    
    toArray in class SortedSet<E>
    
    Parameters:
    
    a - The runtime types of the array being defined by this param
    
    Returns:
    
    The array
  - 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 SortedSet<E>
    
    Parameters:
    
    element - The new element
    
    Returns:
    
    Whether it was added ok.
  - addAll
```
public boolean addAll(Collection 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 SortedSet<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 SortedSet<E>
  - remove
```
public boolean remove(Object element)
```
    Method to remove an element from the SortedSet.
    
    Specified by:
    
    remove in interface Collection<E>
    
    Specified by:
    
    remove in interface Set<E>
    
    Overrides:
    
    remove in class SortedSet<E>
    
    Parameters:
    
    element - The element
    
    Returns:
    
    Whether it was removed ok.
  - remove
```
public boolean remove(Object element,
                      boolean allowCascadeDelete)
```
    Method to remove an element from the collection, and observe the flag for whether to allow cascade delete.
    
    Specified by:
    
    remove in interface SCOCollection<SortedSet<E>,E>
    
    Overrides:
    
    remove in class SortedSet<E>
    
    Parameters:
    
    element - The element
    
    allowCascadeDelete - Whether to allow 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 SortedSet<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 SortedSet<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.
    
    Overrides:
    
    writeReplace in class SortedSet<E>
    
    Returns:
    
    the replaced object
    
    Throws:
    
    ObjectStreamException - if an error occurs
  - spliterator
```
public Spliterator spliterator()
```
    Specified by:
    
    spliterator in interface Iterable<E>
    
    Specified by:
    
    spliterator in interface Collection<E>
    
    Specified by:
    
    spliterator in interface Set<E>
    
    Specified by:
    
    spliterator in interface SortedSet<E>
    
    Overrides:
    
    spliterator in class SortedSet<E>
  - stream
```
public java.util.stream.Stream stream()
```
    Specified by:
    
    stream in interface Collection<E>
    
    Overrides:
    
    stream in class SortedSet<E>
  - parallelStream
```
public java.util.stream.Stream parallelStream()
```
    Specified by:
    
    parallelStream in interface Collection<E>
    
    Overrides:
    
    parallelStream in class SortedSet<E>

Class SortedSet<E>

Modes of Operation

Mutators

Accessors

Field Summary

Fields inherited from class org.datanucleus.store.types.wrappers.SortedSet

Constructor Summary

Method Summary

Methods inherited from class org.datanucleus.store.types.wrappers.SortedSet

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Field Detail

backingStore

allowNulls

useCache

isCacheLoaded

initialising

Constructor Detail

SortedSet

Method Detail

initialise

initialise

initialise

getValue

load

isLoaded

loadFromStore

getBackingStore

updateEmbeddedElement

unsetOwner

clone

comparator

contains

containsAll

equals

forEach

first

hashCode

isEmpty

iterator

headSet

subSet

tailSet

last

size

toArray

toArray

add

addAll

clear

remove

remove

removeAll

retainAll

writeReplace

spliterator

stream

parallelStream