Class Map<K,V>
- java.lang.Object
-
- java.util.AbstractMap<K,V>
-
- org.datanucleus.store.types.wrappers.Map<K,V>
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Map<K,V>
,SCO<Map<K,V>>
,SCOContainer<Map<K,V>>
,SCOMap<Map<K,V>,K,V>
- Direct Known Subclasses:
Map
public class Map<K,V> extends AbstractMap<K,V> implements SCOMap<Map<K,V>,K,V>, Cloneable, Serializable
A mutable second-class Map 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 extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>
-
-
Field Summary
Fields Modifier and Type Field Description protected Map<K,V>
delegate
The internal "delegate".protected AbstractMemberMetaData
ownerMmd
protected ObjectProvider
ownerOP
-
Constructor Summary
Constructors Constructor Description Map(ObjectProvider ownerOP, AbstractMemberMetaData mmd)
Constructor, using the ObjectProvider of the "owner" and the field name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
attachCopy(Map value)
Method to return an attached copy of the passed (detached) value.void
clear()
Method to clear the Map.Object
clone()
Creates and returns a copy of this object.boolean
containsKey(Object key)
Utility to check if a key is contained in the Map.boolean
containsValue(Object value)
Utility to check if a value is contained in the Map.Map
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.void
forEach(java.util.function.BiConsumer<? super K,? super V> action)
V
get(Object key)
Accessor for the value stored against a key.String
getFieldName()
Accessor for the field name.Object
getOwner()
Accessor for the owner.Map
getValue()
Accessor for the unwrapped value that we are wrapping.int
hashCode()
Method to generate a hashcode for this Map.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(Map m)
Method to initialise the SCO for use with the provided initial value.void
initialise(Map 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.void
load()
Method to effect the load of the data in the SCO.void
makeDirty()
Utility to mark the object as dirtyV
put(K key, V value)
Method to add a value to the Map.void
putAll(Map m)
Method to add a Map of values to this map.V
remove(Object key)
Method to remove a value from the Map.void
setValue(Map value)
Method to change the delegate value this wraps (to save recreating the wrapper).int
size()
Method to return the size of the Map.void
unsetOwner()
Method to unset the owner and field information.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 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, replace, replace, replaceAll
-
-
-
-
Field Detail
-
ownerOP
protected transient ObjectProvider ownerOP
-
ownerMmd
protected transient AbstractMemberMetaData ownerMmd
-
-
Constructor Detail
-
Map
public Map(ObjectProvider ownerOP, AbstractMemberMetaData mmd)
Constructor, using the ObjectProvider of the "owner" and the field name.- Parameters:
ownerOP
- The owner ObjectProvidermmd
- Metadata for the member
-
-
Method Detail
-
initialise
public void initialise(Map 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>
- Parameters:
newValue
- New value (to wrap)oldValue
- Old value (to use in deciding what needs deleting etc)
-
initialise
public void initialise(Map 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 interfaceSCO<K>
- 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 interfaceSCO<K>
-
getValue
public Map getValue()
Accessor for the unwrapped value that we are wrapping.
-
setValue
public void setValue(Map value)
Description copied from interface:SCOContainer
Method to change the delegate value this wraps (to save recreating the wrapper).- Specified by:
setValue
in interfaceSCOContainer<K>
- 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<K>
-
isLoaded
public boolean isLoaded()
Method to return if the SCO has its contents loaded. Returns true.- Specified by:
isLoaded
in interfaceSCOContainer<K>
- Returns:
- Whether it is loaded
-
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.
-
getFieldName
public String getFieldName()
Accessor for the field name.- Specified by:
getFieldName
in interfaceSCO<K>
- Returns:
- The field name.
-
getOwner
public Object getOwner()
Accessor for the owner.
-
unsetOwner
public void unsetOwner()
Method to unset the owner and field information.- Specified by:
unsetOwner
in interfaceSCO<K>
-
makeDirty
public void makeDirty()
Utility to mark the object as dirty
-
detachCopy
public Map 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 interfaceSCO<K>
- Parameters:
state
- State for detachment process- Returns:
- The detached container
-
attachCopy
public void attachCopy(Map 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 interfaceSCO<K>
- 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.
-
containsKey
public boolean containsKey(Object key)
Utility to check if a key is contained in the Map.- Specified by:
containsKey
in interfaceMap<K,V>
- Overrides:
containsKey
in classAbstractMap<K,V>
- Parameters:
key
- The key to check- Returns:
- Whether it is contained
-
containsValue
public boolean containsValue(Object value)
Utility to check if a value is contained in the Map.- Specified by:
containsValue
in interfaceMap<K,V>
- Overrides:
containsValue
in classAbstractMap<K,V>
- Parameters:
value
- The value to check- 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.
-
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 Map.
-
putAll
public void putAll(Map m)
Method to add a Map of values to this map.
-
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
-
-