org.datanucleus.store.types.wrappers

Class SortedSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet

org.datanucleus.store.types.wrappers.SortedSet

All Implemented Interfaces:

Serializable, Cloneable, Iterable, Collection, Set, SortedSet, SCO<SortedSet>, SCOCollection<SortedSet>, SCOContainer<SortedSet>

Direct Known Subclasses:

SortedSet

public class SortedSet
extends AbstractSet
implements SortedSet, SCOCollection<SortedSet>, 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:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected SortedSet	delegate The internal "delegate".
protected AbstractMemberMetaData	ownerMmd
protected ObjectProvider	ownerOP

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	add(Object element) Method to add an element to the SortedSet.
boolean	addAll(Collection elements) Method to add a collection to the SortedSet.
void	attachCopy(SortedSet value) Method to return an attached copy of the passed (detached) value.
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.
SortedSet	detachCopy(FetchPlanState state) Method to return a detached copy of the container.
boolean	equals(Object o) Equality operator.
Object	first() Accessor for the first element in the sorted set.
String	getFieldName() Accessor for the field name.
Object	getOwner() Accessor for the owner object.
SortedSet	getValue() Accessor for the unwrapped value that we are wrapping.
int	hashCode() Hashcode operator.
SortedSet	headSet(Object toElement) Method to retrieve the head elements up to the specified 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(SortedSet c) Method to initialise the SCO for use with the provided initial value.
void	initialise(SortedSet 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.
protected void	initialiseDelegate() Convenience method to set up the delegate respecting any comparator specified in MetaData.
boolean	isEmpty() Accessor for whether the SortedSet is empty.
boolean	isLoaded() Method to return if the SCO has its contents loaded.
Iterator	iterator() Accessor for an iterator for the Set.
Object	last() Accessor for the last element in the sorted set.
void	load() Method to effect the load of the data in the SCO.
void	makeDirty() Utility to mark the object as dirty
boolean	remove(Object element) Method to remove an element from the List
boolean	remove(Object element, boolean allowCascadeDelete) Method to remove an element from the List
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).
void	setValue(SortedSet value) Method to change the delegate value this wraps (to save recreating the wrapper).
int	size() Accessor for the size of the SortedSet.
SortedSet	subSet(Object fromElement, Object toElement) Method to retrieve the subset of elements between the specified elements.
SortedSet	tailSet(Object 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(Object 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.AbstractCollection

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.SortedSet

spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

ownerOP

protected transient ObjectProvider ownerOP

ownerMmd

protected transient AbstractMemberMetaData ownerMmd

delegate

protected SortedSet delegate

The internal "delegate".

Constructor Detail

SortedSet

public SortedSet(ObjectProvider ownerOP,
                 AbstractMemberMetaData mmd)

Constructor, using the ObjectProvider of the "owner" and the field name.

Parameters:

ownerOP - The owner ObjectProvider

mmd - Metadata for the member

Method Detail

initialise

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

Parameters:

newValue - New value (to wrap)

oldValue - Old value (to use in deciding what needs deleting etc)

initialise

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

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<SortedSet>

initialiseDelegate

protected void initialiseDelegate()

Convenience method to set up the delegate respecting any comparator specified in MetaData.

getValue

public SortedSet getValue()

Accessor for the unwrapped value that we are wrapping.

Specified by:

getValue in interface SCO<SortedSet>

Returns:

The unwrapped value

setValue

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

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<SortedSet>

isLoaded

public boolean isLoaded()

Method to return if the SCO has its contents loaded. Returns true.

Specified by:

isLoaded in interface SCOContainer<SortedSet>

Returns:

Whether it is loaded

updateEmbeddedElement

public void updateEmbeddedElement(Object element,
                                  int fieldNumber,
                                  Object value,
                                  boolean makeDirty)

Method to update an embedded element in this collection.

Specified by:

updateEmbeddedElement in interface SCOCollection<SortedSet>

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<SortedSet>

Returns:

The field name

getOwner

public Object getOwner()

Accessor for the owner object.

Specified by:

getOwner in interface SCO<SortedSet>

Returns:

The owner object

unsetOwner

public void unsetOwner()

Method to unset the owner and field information.

Specified by:

unsetOwner in interface SCO<SortedSet>

makeDirty

public void makeDirty()

Utility to mark the object as dirty

detachCopy

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

Parameters:

state - State for detachment process

Returns:

The detached container

attachCopy

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

Parameters:

value - The new (collection) value

clone

public Object clone()

Creates and returns a copy of this object.

Specified by:

clone in interface SCO<SortedSet>

Overrides:

clone in class Object

Returns:

The cloned object

comparator

public Comparator comparator()

Accessor for the comparator.

Specified by:

comparator in interface SortedSet

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

Specified by:

contains in interface Set

Overrides:

contains in class AbstractCollection

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

Specified by:

containsAll in interface Set

Overrides:

containsAll in class AbstractCollection

Parameters:

c - The collection

Returns:

Whether it is contained.

equals

public boolean equals(Object o)

Equality operator.

Specified by:

equals in interface Collection

Specified by:

equals in interface Set

Overrides:

equals in class AbstractSet

Parameters:

o - The object to compare against.

Returns:

Whether this object is the same.

first

public Object first()

Accessor for the first element in the sorted set.

Specified by:

first in interface SortedSet

Returns:

The first element

hashCode

public int hashCode()

Hashcode operator.

Specified by:

hashCode in interface Collection

Specified by:

hashCode in interface Set

Overrides:

hashCode in class AbstractSet

Returns:

The Hash code.

isEmpty

public boolean isEmpty()

Accessor for whether the SortedSet is empty.

Specified by:

isEmpty in interface Collection

Specified by:

isEmpty in interface Set

Overrides:

isEmpty in class AbstractCollection

Returns:

Whether it is empty.

iterator

public Iterator iterator()

Accessor for an iterator for the Set.

Specified by:

iterator in interface Iterable

Specified by:

iterator in interface Collection

Specified by:

iterator in interface Set

Specified by:

iterator in class AbstractCollection

Returns:

The iterator

headSet

public SortedSet headSet(Object toElement)

Method to retrieve the head elements up to the specified element.

Specified by:

headSet in interface SortedSet

Parameters:

toElement - the element to return up to.

Returns:

The set of elements meeting the input

subSet

public SortedSet subSet(Object fromElement,
                        Object toElement)

Method to retrieve the subset of elements between the specified elements.

Specified by:

subSet in interface SortedSet

Parameters:

fromElement - The start element

toElement - The end element

Returns:

The set of elements meeting the input

tailSet

public SortedSet tailSet(Object fromElement)

Method to retrieve the set of elements after the specified element.

Specified by:

tailSet in interface SortedSet

Parameters:

fromElement - The start element

Returns:

The set of elements meeting the input

last

public Object last()

Accessor for the last element in the sorted set.

Specified by:

last in interface SortedSet

Returns:

The last element

size

public int size()

Accessor for the size of the SortedSet.

Specified by:

size in interface Collection

Specified by:

size in interface Set

Specified by:

size in class AbstractCollection

Returns:

The size.

toArray

public Object[] toArray()

Method to return the list as an array.

Specified by:

toArray in interface Collection

Specified by:

toArray in interface Set

Overrides:

toArray in class AbstractCollection

Returns:

The array

toArray

public Object[] toArray(Object[] a)

Method to return the list as an array.

Specified by:

toArray in interface Collection

Specified by:

toArray in interface Set

Overrides:

toArray in class AbstractCollection

Parameters:

a - The runtime types of the array being defined by this param

Returns:

The array

add

public boolean add(Object element)

Method to add an element to the SortedSet.

Specified by:

add in interface Collection

Specified by:

add in interface Set

Overrides:

add in class AbstractCollection

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

Specified by:

addAll in interface Set

Overrides:

addAll in class AbstractCollection

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

Specified by:

clear in interface Set

Overrides:

clear in class AbstractCollection

remove

public boolean remove(Object element)

Method to remove an element from the List

Specified by:

remove in interface Collection

Specified by:

remove in interface Set

Overrides:

remove in class AbstractCollection

Parameters:

element - The Element to remove

Returns:

Whether it was removed successfully.

remove

public boolean remove(Object element,
                      boolean allowCascadeDelete)

Method to remove an element from the List

Specified by:

remove in interface SCOCollection<SortedSet>

Parameters:

element - The Element to remove

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

Specified by:

removeAll in interface Set

Overrides:

removeAll in class AbstractSet

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

Specified by:

retainAll in interface Set

Overrides:

retainAll in class AbstractCollection

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