Class TreeMap<K,V>
- java.lang.Object
-
- java.util.AbstractMap<K,V>
-
- java.util.TreeMap<K,V>
-
- org.datanucleus.store.types.wrappers.TreeMap<K,V>
-
- org.datanucleus.store.types.wrappers.backed.TreeMap<K,V>
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Map<K,V>
,NavigableMap<K,V>
,SortedMap<K,V>
,SCO<TreeMap<K,V>>
,SCOContainer<TreeMap<K,V>>
,SCOMap<TreeMap<K,V>,K,V>
,BackedSCO
public class TreeMap<K,V> extends TreeMap<K,V> implements BackedSCO
A mutable second-class TreeMap object. Backed by a MapStore object.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
allowNulls
protected MapStore<K,V>
backingStore
protected boolean
isCacheLoaded
protected boolean
useCache
-
Constructor Summary
Constructors Constructor Description TreeMap(DNStateManager sm, AbstractMemberMetaData mmd)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 keyboolean
containsValue(Object value)
Method to return if the map contains this value.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.K
firstKey()
Accessor for the first key in the sorted map.void
forEach(BiConsumer<? super K,? super V> action)
V
get(Object key)
Accessor for the value stored against a key.Store
getBackingStore()
TreeMap
getValue()
Accessor for the unwrapped value that we are wrapping.int
hashCode()
Method to generate a hashcode for this Map.SortedMap
headMap(K toKey)
Method to retrieve the head of the map up to the specified key.void
initialise()
Method to initialise the SCO for use.void
initialise(TreeMap m)
Method to initialise the SCO from an existing 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.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.K
lastKey()
Accessor for the last key in the sorted map.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.V
put(K key, V 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.V
remove(Object key)
Method to remove the value for a key from the TreeMap.int
size()
Method to return the size of the Map.SortedMap
subMap(K fromKey, K toKey)
Method to retrieve the subset of the map between the specified keys.SortedMap
tailMap(K 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(K key, int fieldNumber, Object newValue, boolean makeDirty)
Method to update an embedded key in this map.void
updateEmbeddedValue(V 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 org.datanucleus.store.types.wrappers.TreeMap
attachCopy, detachCopy, getFieldName, getOwner, initialiseDelegate, makeDirty, setValue
-
Methods inherited from class java.util.TreeMap
ceilingEntry, ceilingKey, descendingKeySet, descendingMap, firstEntry, floorEntry, floorKey, 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
-
-
-
-
Constructor Detail
-
TreeMap
public TreeMap(DNStateManager sm, AbstractMemberMetaData mmd)
Constructor- Parameters:
sm
- the owner StateManagermmd
- 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 interfaceSCO<K>
- Overrides:
initialise
in classTreeMap<K,V>
- Parameters:
newValue
- New value (to wrap)oldValue
- Old value (to use in deciding what needs deleting etc)
-
initialise
public void initialise(TreeMap m)
Method to initialise the SCO from an existing value.- Specified by:
initialise
in interfaceSCO<K>
- Overrides:
initialise
in classTreeMap<K,V>
- Parameters:
m
- Object to set value using.
-
initialise
public void initialise()
Method to initialise the SCO for use.- Specified by:
initialise
in interfaceSCO<K>
- Overrides:
initialise
in classTreeMap<K,V>
-
getValue
public TreeMap 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
-
updateEmbeddedKey
public void updateEmbeddedKey(K key, int fieldNumber, Object newValue, boolean makeDirty)
Method to update an embedded key in this map.
-
updateEmbeddedValue
public void updateEmbeddedValue(V value, int fieldNumber, Object newValue, boolean makeDirty)
Method to update an embedded value in this map.
-
unsetOwner
public void unsetOwner()
Method to unset the owner and field details.- Specified by:
unsetOwner
in interfaceSCO<K>
- Overrides:
unsetOwner
in classTreeMap<K,V>
-
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.
-
comparator
public Comparator comparator()
Accessor for the comparator.- Specified by:
comparator
in interfaceSortedMap<K,V>
- Overrides:
comparator
in classTreeMap<K,V>
- Returns:
- The comparator
-
containsKey
public boolean containsKey(Object key)
Method to return if the map contains this key- Specified by:
containsKey
in interfaceMap<K,V>
- Overrides:
containsKey
in classTreeMap<K,V>
- 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 interfaceMap<K,V>
- Overrides:
containsValue
in classTreeMap<K,V>
- Parameters:
value
- The value- Returns:
- Whether it is contained
-
entrySet
public Set entrySet()
Accessor for the set of entries in the Map.
-
equals
public boolean equals(Object o)
Method to check the equality of this map, and another.
-
firstKey
public K firstKey()
Accessor for the first key in the sorted map.
-
forEach
public void forEach(BiConsumer<? super K,? super V> action)
-
lastKey
public K lastKey()
Accessor for the last key in the sorted map.
-
headMap
public SortedMap headMap(K toKey)
Method to retrieve the head of the map up to the specified key.
-
subMap
public SortedMap subMap(K fromKey, K toKey)
Method to retrieve the subset of the map between the specified keys.
-
tailMap
public SortedMap tailMap(K fromKey)
Method to retrieve the part of the map after the specified key.
-
hashCode
public int hashCode()
Method to generate a hashcode for this Map.
-
isEmpty
public boolean isEmpty()
Method to return if the Map is empty.
-
keySet
public Set keySet()
Accessor for the set of keys in the Map.
-
size
public int size()
Method to return the size of the Map.
-
values
public Collection values()
Accessor for the set of values in the Map.
-
clear
public void clear()
Method to clear the TreeMap.
-
putAll
public void putAll(Map m)
Method to add the specified Map's values under their keys here.
-
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.- Overrides:
writeReplace
in classTreeMap<K,V>
- Returns:
- the replaced object
- Throws:
ObjectStreamException
- if an error occurs
-
-