TreeMap (DataNucleus Core 4.1.1 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.TreeMap
  - - org.datanucleus.store.types.wrappers.TreeMap

All Implemented Interfaces:

Serializable, Cloneable, Map, NavigableMap, SortedMap, SCO<TreeMap>, SCOContainer<TreeMap>, SCOMap<TreeMap>

Direct Known Subclasses:

TreeMap
```
public class TreeMap
extends TreeMap
implements SCOMap<TreeMap>
```
A mutable second-class TreeMap 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

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields
Modifier and Type Field and Description

protected TreeMap delegate
The internal "delegate".

protected AbstractMemberMetaData ownerMmd

protected ObjectProvider ownerOP

Fields
Modifier and Type	Field and Description
`protected TreeMap`	`delegate` The internal "delegate".
`protected AbstractMemberMetaData`	`ownerMmd`
`protected ObjectProvider`	`ownerOP`

Constructor Summary

Constructors
Constructor and Description

TreeMap(ObjectProvider ownerOP, AbstractMemberMetaData mmd)
Constructor

Constructors
Constructor and Description
`TreeMap(ObjectProvider ownerOP, AbstractMemberMetaData mmd)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`attachCopy(TreeMap value)` Method to return an attached copy of the passed (detached) value.
`void`	`clear()` Method to clear the TreeMap.
`Object`	`clone()` Creates and returns a copy of this object.
`Comparator`	`comparator()` Accessor for the comparator.
`boolean`	`containsKey(Object key)` Method to return if the map contains this key
`boolean`	`containsValue(Object value)` Method to return if the map contains this value.
`TreeMap`	`detachCopy(FetchPlanState state)` Method to return a detached copy of the container.
`Set`	`entrySet()` Accessor for the set of entries in the Map.
`boolean`	`equals(Object o)` Method to check the equality of this map, and another.
`Object`	`firstKey()` Accessor for the first key in the sorted map.
`Object`	`get(Object key)` Accessor for the value stored against a key.
`String`	`getFieldName()` Accessor for the field name that this TreeMap relates to.
`Object`	`getOwner()` Accessor for the owner that this TreeMap relates to.
`TreeMap`	`getValue()` Accessor for the unwrapped value that we are wrapping.
`int`	`hashCode()` Method to generate a hashcode for this Map.
`SortedMap`	`headMap(Object toKey)` Method to retrieve the head of the map up to the specified key.
`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(TreeMap m)` Method to initialise the SCO for use with the provided initial value.
`void`	`initialise(TreeMap 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()` Method to return if the Map is empty.
`boolean`	`isLoaded()` Method to return if the SCO has its contents loaded.
`Set`	`keySet()` Accessor for the set of keys in the Map.
`Object`	`lastKey()` Accessor for the last key in the sorted map.
`void`	`load()` Method to effect the load of the data in the SCO.
`void`	`makeDirty()` Utility to mark the object as dirty
`Object`	`put(Object key, Object value)` Method to add a value against a key to the TreeMap.
`void`	`putAll(Map m)` Method to add the specified Map's values under their keys here.
`Object`	`remove(Object key)` Method to remove the value for a key from the TreeMap.
`void`	`setValue(TreeMap value)` Method to change the delegate value this wraps (to save recreating the wrapper).
`int`	`size()` Method to return the size of the Map.
`SortedMap`	`subMap(Object fromKey, Object toKey)` Method to retrieve the subset of the map between the specified keys.
`SortedMap`	`tailMap(Object fromKey)` Method to retrieve the part of the map after the specified key.
`void`	`unsetOwner()` Method to unset the owner and field details.
`void`	`updateEmbeddedKey(Object key, int fieldNumber, Object newValue, boolean makeDirty)` Method to update an embedded key in this map.
`void`	`updateEmbeddedValue(Object value, int fieldNumber, Object newValue, boolean makeDirty)` Method to update an embedded value in this map.
`Collection`	`values()` Accessor for the set of values in the Map.
`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.TreeMap
ceilingEntry, ceilingKey, descendingKeySet, descendingMap, firstEntry, floorEntry, floorKey, forEach, headMap, higherEntry, higherKey, lastEntry, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, replace, replace, replaceAll, subMap, tailMap

Methods inherited from class java.util.AbstractMap
toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, getOrDefault, merge, putIfAbsent, remove

- Field Detail
  - ownerOP
```
protected transient ObjectProvider ownerOP
```
  - ownerMmd
```
protected transient AbstractMemberMetaData ownerMmd
```
  - delegate
```
protected TreeMap delegate
```
    The internal "delegate".
- Constructor Detail
  - TreeMap
```
public TreeMap(ObjectProvider ownerOP,
               AbstractMemberMetaData mmd)
```
    Constructor
    
    Parameters:
    
    ownerOP - the owner ObjectProvider
    
    mmd - Metadata for the member
- Method Detail
  - initialise
```
public void initialise(TreeMap 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<TreeMap>
    
    Parameters:
    
    newValue - New value (to wrap)
    
    oldValue - Old value (to use in deciding what needs deleting etc)
  - initialise
```
public void initialise(TreeMap m)
```
    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<TreeMap>
    
    Parameters:
    
    m - 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<TreeMap>
  - initialiseDelegate
```
protected void initialiseDelegate()
```
    Convenience method to set up the delegate respecting any comparator specified in MetaData.
  - getValue
```
public TreeMap getValue()
```
    Accessor for the unwrapped value that we are wrapping.
    
    Specified by:
    
    getValue in interface SCO<TreeMap>
    
    Returns:
    
    The unwrapped value
  - setValue
```
public void setValue(TreeMap 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<TreeMap>
    
    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<TreeMap>
  - isLoaded
```
public boolean isLoaded()
```
    Method to return if the SCO has its contents loaded. Returns true.
    
    Specified by:
    
    isLoaded in interface SCOContainer<TreeMap>
    
    Returns:
    
    Whether it is loaded
  - updateEmbeddedKey
```
public void updateEmbeddedKey(Object key,
                              int fieldNumber,
                              Object newValue,
                              boolean makeDirty)
```
    Method to update an embedded key in this map.
    
    Specified by:
    
    updateEmbeddedKey in interface SCOMap<TreeMap>
    
    Parameters:
    
    key - The key
    
    fieldNumber - Number of field in the key
    
    newValue - New value for this field
    
    makeDirty - Whether to make the SCO field dirty.
  - updateEmbeddedValue
```
public void updateEmbeddedValue(Object value,
                                int fieldNumber,
                                Object newValue,
                                boolean makeDirty)
```
    Method to update an embedded value in this map.
    
    Specified by:
    
    updateEmbeddedValue in interface SCOMap<TreeMap>
    
    Parameters:
    
    value - The value
    
    fieldNumber - Number of field in the value
    
    newValue - New value for this field
    
    makeDirty - Whether to make the SCO field dirty.
  - getFieldName
```
public String getFieldName()
```
    Accessor for the field name that this TreeMap relates to.
    
    Specified by:
    
    getFieldName in interface SCO<TreeMap>
    
    Returns:
    
    The field name
  - getOwner
```
public Object getOwner()
```
    Accessor for the owner that this TreeMap relates to.
    
    Specified by:
    
    getOwner in interface SCO<TreeMap>
    
    Returns:
    
    The owner
  - unsetOwner
```
public void unsetOwner()
```
    Method to unset the owner and field details.
    
    Specified by:
    
    unsetOwner in interface SCO<TreeMap>
  - makeDirty
```
public void makeDirty()
```
    Utility to mark the object as dirty
  - detachCopy
```
public TreeMap detachCopy(FetchPlanState state)
```
    Method to return a detached copy of the container. Recurse sthrough the keys/values so that they are likewise detached.
    
    Specified by:
    
    detachCopy in interface SCO<TreeMap>
    
    Parameters:
    
    state - State for detachment process
    
    Returns:
    
    The detached container
  - attachCopy
```
public void attachCopy(TreeMap value)
```
    Method to return an attached copy of the passed (detached) value. The returned attached copy is a SCO wrapper. Goes through the existing keys/values in the store for this owner field and removes ones no longer present, and adds new keys/values. All keys/values in the (detached) value are attached.
    
    Specified by:
    
    attachCopy in interface SCO<TreeMap>
    
    Parameters:
    
    value - The new (map) value
  - clone
```
public Object clone()
```
    Creates and returns a copy of this object.
    Mutable second-class Objects are required to provide a public clone method in order to allow for copying persistable objects. In contrast to Object.clone(), this method must not throw a CloneNotSupportedException.
    
    Specified by:
    
    clone in interface SCO<TreeMap>
    
    Overrides:
    
    clone in class TreeMap
    
    Returns:
    
    The cloned object
  - comparator
```
public Comparator comparator()
```
    Accessor for the comparator.
    
    Specified by:
    
    comparator in interface SortedMap
    
    Overrides:
    
    comparator in class TreeMap
    
    Returns:
    
    The comparator
  - containsKey
```
public boolean containsKey(Object key)
```
    Method to return if the map contains this key
    
    Specified by:
    
    containsKey in interface Map
    
    Overrides:
    
    containsKey in class TreeMap
    
    Parameters:
    
    key - The key
    
    Returns:
    
    Whether it is contained
  - containsValue
```
public boolean containsValue(Object value)
```
    Method to return if the map contains this value.
    
    Specified by:
    
    containsValue in interface Map
    
    Overrides:
    
    containsValue in class TreeMap
    
    Parameters:
    
    value - The value
    
    Returns:
    
    Whether it is contained
  - entrySet
```
public Set entrySet()
```
    Accessor for the set of entries in the Map.
    
    Specified by:
    
    entrySet in interface Map
    
    Specified by:
    
    entrySet in interface SortedMap
    
    Overrides:
    
    entrySet in class TreeMap
    
    Returns:
    
    Set of entries
  - equals
```
public boolean equals(Object o)
```
    Method to check the equality of this map, and another.
    
    Specified by:
    
    equals in interface Map
    
    Overrides:
    
    equals in class AbstractMap
    
    Parameters:
    
    o - The map to compare against.
    
    Returns:
    
    Whether they are equal.
  - firstKey
```
public Object firstKey()
```
    Accessor for the first key in the sorted map.
    
    Specified by:
    
    firstKey in interface SortedMap
    
    Overrides:
    
    firstKey in class TreeMap
    
    Returns:
    
    The first key
  - lastKey
```
public Object lastKey()
```
    Accessor for the last key in the sorted map.
    
    Specified by:
    
    lastKey in interface SortedMap
    
    Overrides:
    
    lastKey in class TreeMap
    
    Returns:
    
    The last key
  - headMap
```
public SortedMap headMap(Object toKey)
```
    Method to retrieve the head of the map up to the specified key.
    
    Specified by:
    
    headMap in interface NavigableMap
    
    Specified by:
    
    headMap in interface SortedMap
    
    Overrides:
    
    headMap in class TreeMap
    
    Parameters:
    
    toKey - the key to return up to.
    
    Returns:
    
    The map meeting the input
  - subMap
```
public SortedMap subMap(Object fromKey,
                        Object toKey)
```
    Method to retrieve the subset of the map between the specified keys.
    
    Specified by:
    
    subMap in interface NavigableMap
    
    Specified by:
    
    subMap in interface SortedMap
    
    Overrides:
    
    subMap in class TreeMap
    
    Parameters:
    
    fromKey - The start key
    
    toKey - The end key
    
    Returns:
    
    The map meeting the input
  - tailMap
```
public SortedMap tailMap(Object fromKey)
```
    Method to retrieve the part of the map after the specified key.
    
    Specified by:
    
    tailMap in interface NavigableMap
    
    Specified by:
    
    tailMap in interface SortedMap
    
    Overrides:
    
    tailMap in class TreeMap
    
    Parameters:
    
    fromKey - The start key
    
    Returns:
    
    The map meeting the input
  - get
```
public Object get(Object key)
```
    Accessor for the value stored against a key.
    
    Specified by:
    
    get in interface Map
    
    Overrides:
    
    get in class TreeMap
    
    Parameters:
    
    key - The key
    
    Returns:
    
    The value.
  - hashCode
```
public int hashCode()
```
    Method to generate a hashcode for this Map.
    
    Specified by:
    
    hashCode in interface Map
    
    Overrides:
    
    hashCode in class AbstractMap
    
    Returns:
    
    The hashcode.
  - isEmpty
```
public boolean isEmpty()
```
    Method to return if the Map is empty.
    
    Specified by:
    
    isEmpty in interface Map
    
    Overrides:
    
    isEmpty in class AbstractMap
    
    Returns:
    
    Whether it is empty.
  - keySet
```
public Set keySet()
```
    Accessor for the set of keys in the Map.
    
    Specified by:
    
    keySet in interface Map
    
    Specified by:
    
    keySet in interface SortedMap
    
    Overrides:
    
    keySet in class TreeMap
    
    Returns:
    
    Set of keys.
  - size
```
public int size()
```
    Method to return the size of the Map.
    
    Specified by:
    
    size in interface Map
    
    Overrides:
    
    size in class TreeMap
    
    Returns:
    
    The size
  - values
```
public Collection values()
```
    Accessor for the set of values in the Map.
    
    Specified by:
    
    values in interface Map
    
    Specified by:
    
    values in interface SortedMap
    
    Overrides:
    
    values in class TreeMap
    
    Returns:
    
    Set of values.
  - clear
```
public void clear()
```
    Method to clear the TreeMap.
    
    Specified by:
    
    clear in interface Map
    
    Overrides:
    
    clear in class TreeMap
  - put
```
public Object put(Object key,
                  Object value)
```
    Method to add a value against a key to the TreeMap.
    
    Specified by:
    
    put in interface Map
    
    Overrides:
    
    put in class TreeMap
    
    Parameters:
    
    key - The key
    
    value - The value
    
    Returns:
    
    The previous value for the specified key.
  - putAll
```
public void putAll(Map m)
```
    Method to add the specified Map's values under their keys here.
    
    Specified by:
    
    putAll in interface Map
    
    Overrides:
    
    putAll in class TreeMap
    
    Parameters:
    
    m - The map
  - remove
```
public Object remove(Object key)
```
    Method to remove the value for a key from the TreeMap.
    
    Specified by:
    
    remove in interface Map
    
    Overrides:
    
    remove in class TreeMap
    
    Parameters:
    
    key - The key to remove
    
    Returns:
    
    The value that was removed from this key.
  - 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

Class TreeMap

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.TreeMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

ownerOP

ownerMmd

delegate

Constructor Detail

TreeMap

Method Detail

initialise

initialise

initialise

initialiseDelegate

getValue

setValue

load

isLoaded

updateEmbeddedKey

updateEmbeddedValue

getFieldName

getOwner

unsetOwner

makeDirty

detachCopy

attachCopy

clone

comparator

containsKey

containsValue

entrySet

equals

firstKey

lastKey

headMap

subMap

tailMap

get

hashCode

isEmpty

keySet

size

values

clear

put

putAll

remove

writeReplace