Class SortedSet<E>
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
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
protected boolean
protected boolean
protected boolean
-
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
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.boolean
Equality operator.first()
Accessor for the first element in the sorted set.void
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.void
initialise
(SortedSet<E> 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()
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.protected void
Method to load all elements from the "backing store" where appropriate.boolean
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
Method to retain a Collection of elements (and remove all others).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 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 Details
-
backingStore
-
allowNulls
protected transient boolean allowNulls -
useCache
protected transient boolean useCache -
isCacheLoaded
protected transient boolean isCacheLoaded -
initialising
protected transient boolean initialising
-
-
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>
- Overrides:
initialise
in classSortedSet<E>
- Parameters:
newValue
- New value (to wrap)oldValue
- Old value (to use in deciding what needs deleting etc)
-
initialise
Method to initialise the SCO from an existing value.- Specified by:
initialise
in interfaceSCO<E>
- Overrides:
initialise
in classSortedSet<E>
- Parameters:
c
- The object to set from
-
initialise
public void initialise()Method to initialise the SCO for use.- Specified by:
initialise
in interfaceSCO<E>
- Overrides:
initialise
in classSortedSet<E>
-
getValue
Accessor for the unwrapped value that we are wrapping. -
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. -
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. -
loadFromStore
protected void loadFromStore()Method to load all elements from the "backing store" where appropriate. -
getBackingStore
- Specified by:
getBackingStore
in interfaceBackedSCO
-
updateEmbeddedElement
Method to update an embedded element in this collection.- Specified by:
updateEmbeddedElement
in interfaceSCOCollection<SortedSet<E>,
E> - Overrides:
updateEmbeddedElement
in classSortedSet<E>
- Parameters:
element
- The elementfieldNumber
- Number of field in the elementvalue
- New value for this fieldmakeDirty
- Whether to make the SCO field dirty.
-
unsetOwner
public void unsetOwner()Method to unset the owner and field information.- Specified by:
unsetOwner
in interfaceSCO<E>
- Overrides:
unsetOwner
in classSortedSet<E>
-
clone
Creates and returns a copy of this object. -
comparator
Description copied from class:SortedSet
Accessor for the comparator.- Specified by:
comparator
in interfaceSortedSet<E>
- Overrides:
comparator
in classSortedSet<E>
- Returns:
- The comparator
-
contains
Description copied from class:SortedSet
Accessor for whether an element is contained in this Set. -
containsAll
Description copied from class:SortedSet
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 classSortedSet<E>
- Parameters:
c
- The collection- Returns:
- Whether it is contained.
-
equals
Description copied from class:SortedSet
Equality operator. -
forEach
-
first
Description copied from class:SortedSet
Accessor for the first element in the sorted set. -
hashCode
public int hashCode()Description copied from class:SortedSet
Hashcode operator. -
isEmpty
public boolean isEmpty()Description copied from class:SortedSet
Accessor for whether the SortedSet is empty. -
iterator
Description copied from class:SortedSet
Accessor for an iterator for the Set. -
headSet
Description copied from class:SortedSet
Method to retrieve the head elements up to the specified element. -
subSet
Description copied from class:SortedSet
Method to retrieve the subset of elements between the specified elements. -
tailSet
Description copied from class:SortedSet
Method to retrieve the set of elements after the specified element. -
last
Description copied from class:SortedSet
Accessor for the last element in the sorted set. -
size
public int size()Description copied from class:SortedSet
Accessor for the size of the SortedSet. -
toArray
-
toArray
public <T> T[] toArray(T[] a) -
add
Description copied from class:SortedSet
Method to add an element to the SortedSet. -
addAll
Description copied from class:SortedSet
Method to add a collection to the SortedSet. -
clear
public void clear()Description copied from class:SortedSet
Method to clear the SortedSet -
remove
Description copied from class:SortedSet
Method to remove (the first occurrence of) an element from the collection -
remove
Description copied from class:SortedSet
Method to remove (the first occurrence of) an element from the collection -
removeAll
Description copied from class:SortedSet
Method to remove all elements from the collection from the SortedSet. -
retainAll
Description copied from class:SortedSet
Method to retain a Collection of elements (and remove all others). -
writeReplace
Description copied from class:SortedSet
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 classSortedSet<E>
- Returns:
- the replaced object
- Throws:
ObjectStreamException
- if an error occurs
-
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>
- Overrides:
spliterator
in classSortedSet<E>
-
stream
-
parallelStream
- Specified by:
parallelStream
in interfaceCollection<E>
- Overrides:
parallelStream
in classSortedSet<E>
-