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 Summary
FieldsModifier and TypeFieldDescriptionThe internal "delegate".protected AbstractMemberMetaData
protected DNStateManager
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor, using StateManager of the "owner" and the field name. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Method to add an element to the SortedSet.boolean
addAll
(Collection<? extends E> elements) Method to add a collection to the SortedSet.void
attachCopy
(SortedSet<E> value) Method to return an attached copy of the passed (detached) value.void
clear()
Method to clear the SortedSetclone()
Creates and returns a copy of this object.Comparator
<? super E> Accessor for the comparator.boolean
Accessor for whether an element is contained in this Set.boolean
containsAll
(Collection<?> c) Accessor for whether a collection is contained in this Set.detachCopy
(FetchPlanState state) Method to return a detached copy of the container.boolean
Equality operator.first()
Accessor for the first element in the sorted set.void
Accessor for the field name.getOwner()
Accessor for the owner object.getValue()
Accessor for the unwrapped value that we are wrapping.int
hashCode()
Hashcode operator.Method to retrieve the head elements up to the specified element.void
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<E> c) Method to initialise the SCO for use with the provided initial 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.protected void
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()
Accessor for an iterator for the Set.last()
Accessor for the last element in the sorted set.void
load()
Method to effect the load of the data in the SCO.void
Utility to mark the object as dirtyboolean
Method to remove (the first occurrence of) an element from the collectionboolean
Method to remove (the first occurrence of) an element from the collectionboolean
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
Method to change the delegate value this wraps (to save recreating the wrapper).int
size()
Accessor for the size of the SortedSet.stream()
Method to retrieve the subset of elements between the specified elements.Method to retrieve the set of elements after the specified element.Object[]
toArray()
<T> T[]
toArray
(T[] a) void
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
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.Collection
removeIf
-
Field Details
-
ownerSM
-
ownerMmd
-
delegate
The internal "delegate".
-
-
Constructor Details
-
SortedSet
Constructor, using StateManager of the "owner" and the field name.- Parameters:
sm
- The owner StateManagermmd
- Metadata for the member
-
-
Method Details
-
initialise
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
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
Accessor for the unwrapped value that we are wrapping. -
setValue
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
Method to update an embedded element in this collection.- Specified by:
updateEmbeddedElement
in interfaceSCOCollection<SortedSet<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
Accessor for the field name.- Specified by:
getFieldName
in interfaceSCO<E>
- Returns:
- The field name
-
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
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
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
Creates and returns a copy of this object. -
comparator
Accessor for the comparator.- Specified by:
comparator
in interfaceSortedSet<E>
- Returns:
- The comparator
-
contains
Accessor for whether an element is contained in this Set.- Specified by:
contains
in interfaceCollection<E>
- Specified by:
contains
in interfaceSet<E>
- Overrides:
contains
in classAbstractCollection<E>
- Parameters:
element
- The element- Returns:
- Whether it is contained.
-
containsAll
Accessor for whether a collection is contained in this Set.- Specified by:
containsAll
in interfaceCollection<E>
- Specified by:
containsAll
in interfaceSet<E>
- Overrides:
containsAll
in classAbstractCollection<E>
- Parameters:
c
- The collection- Returns:
- Whether it is contained.
-
equals
Equality operator.- Specified by:
equals
in interfaceCollection<E>
- Specified by:
equals
in interfaceSet<E>
- Overrides:
equals
in classAbstractSet<E>
- Parameters:
o
- The object to compare against.- Returns:
- Whether this object is the same.
-
first
Accessor for the first element in the sorted set. -
hashCode
public int hashCode()Hashcode operator.- Specified by:
hashCode
in interfaceCollection<E>
- Specified by:
hashCode
in interfaceSet<E>
- Overrides:
hashCode
in classAbstractSet<E>
- Returns:
- The Hash code.
-
isEmpty
public boolean isEmpty()Accessor for whether the SortedSet is empty.- Specified by:
isEmpty
in interfaceCollection<E>
- Specified by:
isEmpty
in interfaceSet<E>
- Overrides:
isEmpty
in classAbstractCollection<E>
- Returns:
- Whether it is empty.
-
iterator
Accessor for an iterator for the Set. -
headSet
Method to retrieve the head elements up to the specified element. -
subSet
Method to retrieve the subset of elements between the specified elements. -
tailSet
Method to retrieve the set of elements after the specified element. -
last
Accessor for the last element in the sorted set. -
size
public int size()Accessor for the size of the SortedSet.- Specified by:
size
in interfaceCollection<E>
- Specified by:
size
in interfaceSet<E>
- Specified by:
size
in classAbstractCollection<E>
- Returns:
- The size.
-
toArray
- Specified by:
toArray
in interfaceCollection<E>
- Specified by:
toArray
in interfaceSet<E>
- Overrides:
toArray
in classAbstractCollection<E>
-
toArray
public <T> T[] toArray(T[] a) - Specified by:
toArray
in interfaceCollection<E>
- Specified by:
toArray
in interfaceSet<E>
- Overrides:
toArray
in classAbstractCollection<E>
-
add
Method to add an element to the SortedSet.- Specified by:
add
in interfaceCollection<E>
- Specified by:
add
in interfaceSet<E>
- Overrides:
add
in classAbstractCollection<E>
- Parameters:
element
- The new element- Returns:
- Whether it was added ok.
-
addAll
Method to add a collection to the SortedSet.- Specified by:
addAll
in interfaceCollection<E>
- Specified by:
addAll
in interfaceSet<E>
- Overrides:
addAll
in classAbstractCollection<E>
- Parameters:
elements
- The collection- Returns:
- Whether it was added ok.
-
clear
public void clear()Method to clear the SortedSet- Specified by:
clear
in interfaceCollection<E>
- Specified by:
clear
in interfaceSet<E>
- Overrides:
clear
in classAbstractCollection<E>
-
remove
Method to remove (the first occurrence of) an element from the collection- Specified by:
remove
in interfaceCollection<E>
- Specified by:
remove
in interfaceSet<E>
- Overrides:
remove
in classAbstractCollection<E>
- Parameters:
element
- The Element to remove- Returns:
- Whether it was removed successfully.
-
remove
Method to remove (the first occurrence of) an element from the collection- Specified by:
remove
in interfaceSCOCollection<SortedSet<E>,
E> - Parameters:
element
- The Element to removeallowCascadeDelete
- Whether to cascade delete- Returns:
- Whether it was removed successfully.
-
removeAll
Method to remove all elements from the collection from the SortedSet.- Specified by:
removeAll
in interfaceCollection<E>
- Specified by:
removeAll
in interfaceSet<E>
- Overrides:
removeAll
in classAbstractSet<E>
- Parameters:
elements
- The collection of elements to remove- Returns:
- Whether it was removed ok.
-
retainAll
Method to retain a Collection of elements (and remove all others).- Specified by:
retainAll
in interfaceCollection<E>
- Specified by:
retainAll
in interfaceSet<E>
- Overrides:
retainAll
in classAbstractCollection<E>
- Parameters:
c
- The collection to retain- Returns:
- Whether they were retained successfully.
-
writeReplace
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
-
stream
- Specified by:
stream
in interfaceCollection<E>
-
parallelStream
- Specified by:
parallelStream
in interfaceCollection<E>
-
spliterator
- Specified by:
spliterator
in interfaceCollection<E>
- Specified by:
spliterator
in interfaceIterable<E>
- Specified by:
spliterator
in interfaceSet<E>
- Specified by:
spliterator
in interfaceSortedSet<E>
-