Class TreeSet<E>
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractSet<E>
-
- java.util.TreeSet<E>
-
- org.datanucleus.store.types.wrappers.TreeSet<E>
-
- org.datanucleus.store.types.wrappers.backed.TreeSet<E>
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Iterable<E>
,Collection<E>
,NavigableSet<E>
,Set<E>
,SortedSet<E>
,SCO<TreeSet<E>>
,SCOCollection<TreeSet<E>,E>
,SCOContainer<TreeSet<E>>
,BackedSCO
public class TreeSet<E> extends TreeSet<E> implements BackedSCO
A mutable second-class TreeSet object. This class extends TreeSet, 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 Description protected boolean
allowNulls
protected SetStore<E>
backingStore
protected boolean
initialising
protected boolean
isCacheLoaded
protected boolean
useCache
-
Constructor Summary
Constructors Constructor Description TreeSet(DNStateManager sm, AbstractMemberMetaData mmd)
Constructor, using StateManager of the "owner" and the field name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
add(E element)
Method to add an element to the TreeSet.boolean
addAll(Collection elements)
Method to add a collection to the TreeSet.void
clear()
Method to clear the TreeSetObject
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)
E
first()
Accessor for the first element in the sorted set.void
forEach(Consumer action)
Store
getBackingStore()
TreeSet
getValue()
Accessor for the unwrapped value that we are wrapping.int
hashCode()
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(TreeSet c)
Method to initialise the SCO from an existing value.void
initialise(TreeSet<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 TreeSet 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.Stream
parallelStream()
boolean
remove(Object element)
Method to remove (the first occurrence of) an element from the collectionboolean
remove(Object element, boolean allowCascadeDelete)
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 TreeSet.boolean
retainAll(Collection c)
Method to retain a Collection of elements (and remove all others).int
size()
Accessor for the size of the TreeSet.Spliterator
spliterator()
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.TreeSet
attachCopy, detachCopy, getFieldName, getOwner, initialiseDelegate, makeDirty, setValue
-
Methods inherited from class java.util.TreeSet
ceiling, descendingIterator, descendingSet, floor, headSet, higher, lower, pollFirst, pollLast, subSet, tailSet
-
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, toArray
-
-
-
-
Constructor Detail
-
TreeSet
public TreeSet(DNStateManager sm, AbstractMemberMetaData mmd)
Constructor, using StateManager of the "owner" and the field name.- Parameters:
sm
- The owner StateManagermmd
- Metadata for the member
-
-
Method Detail
-
initialise
public void initialise(TreeSet<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 interfaceSCO<E>
- Overrides:
initialise
in classTreeSet<E>
- Parameters:
newValue
- New value (to wrap)oldValue
- Old value (to use in deciding what needs deleting etc)
-
initialise
public void initialise(TreeSet c)
Method to initialise the SCO from an existing value.- Specified by:
initialise
in interfaceSCO<E>
- Overrides:
initialise
in classTreeSet<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 classTreeSet<E>
-
getValue
public TreeSet 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
public Store getBackingStore()
- Specified by:
getBackingStore
in interfaceBackedSCO
-
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 interfaceSCOCollection<TreeSet<E>,E>
- Overrides:
updateEmbeddedElement
in classTreeSet<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 classTreeSet<E>
-
clone
public Object clone()
Creates and returns a copy of this object.
-
comparator
public Comparator comparator()
Description copied from class:TreeSet
Accessor for the comparator.- Specified by:
comparator
in interfaceSortedSet<E>
- Overrides:
comparator
in classTreeSet<E>
- Returns:
- The comparator
-
contains
public boolean contains(Object element)
Description copied from class:TreeSet
Accessor for whether an element is contained in this Set.
-
containsAll
public boolean containsAll(Collection c)
Description copied from class:TreeSet
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 classTreeSet<E>
- Parameters:
c
- The collection- Returns:
- Whether it is contained.
-
equals
public boolean equals(Object o)
-
first
public E first()
Description copied from class:TreeSet
Accessor for the first element in the sorted set.
-
hashCode
public int hashCode()
-
isEmpty
public boolean isEmpty()
Description copied from class:TreeSet
Accessor for whether the TreeSet is empty.
-
iterator
public Iterator<E> iterator()
Description copied from class:TreeSet
Accessor for an iterator for the Set.
-
headSet
public SortedSet headSet(E toElement)
Description copied from class:TreeSet
Method to retrieve the head elements up to the specified element.
-
subSet
public SortedSet subSet(E fromElement, E toElement)
Description copied from class:TreeSet
Method to retrieve the subset of elements between the specified elements.
-
tailSet
public SortedSet tailSet(E fromElement)
Description copied from class:TreeSet
Method to retrieve the set of elements after the specified element.
-
last
public E last()
Description copied from class:TreeSet
Accessor for the last element in the sorted set.
-
size
public int size()
Description copied from class:TreeSet
Accessor for the size of the TreeSet.
-
toArray
public Object[] toArray()
Description copied from class:TreeSet
Method to return the list as an array.
-
toArray
public Object[] toArray(Object[] a)
Description copied from class:TreeSet
Method to return the list as an array.
-
add
public boolean add(E element)
Description copied from class:TreeSet
Method to add an element to the TreeSet.
-
addAll
public boolean addAll(Collection elements)
Description copied from class:TreeSet
Method to add a collection to the TreeSet.
-
clear
public void clear()
Description copied from class:TreeSet
Method to clear the TreeSet
-
remove
public boolean remove(Object element)
Description copied from class:TreeSet
Method to remove (the first occurrence of) an element from the collection
-
remove
public boolean remove(Object element, boolean allowCascadeDelete)
Description copied from class:TreeSet
Method to remove (the first occurrence of) an element from the collection
-
removeAll
public boolean removeAll(Collection elements)
Description copied from class:TreeSet
Method to remove all elements from the collection from the TreeSet.
-
retainAll
public boolean retainAll(Collection c)
Description copied from class:TreeSet
Method to retain a Collection of elements (and remove all others).
-
writeReplace
protected Object writeReplace() throws ObjectStreamException
Description copied from class:TreeSet
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 classTreeSet<E>
- Returns:
- the replaced object
- Throws:
ObjectStreamException
- if an error occurs
-
spliterator
public Spliterator 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 classTreeSet<E>
-
stream
public Stream stream()
-
parallelStream
public Stream parallelStream()
- Specified by:
parallelStream
in interfaceCollection<E>
- Overrides:
parallelStream
in classTreeSet<E>
-
-