Class HashMap<K,V>
- java.lang.Object
-
- java.util.AbstractMap<K,V>
-
- java.util.HashMap<K,V>
-
- org.datanucleus.store.types.wrappers.HashMap<K,V>
-
- org.datanucleus.store.types.wrappers.backed.HashMap<K,V>
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.util.Map<K,V>
,SCO<java.util.HashMap<K,V>>
,SCOContainer<java.util.HashMap<K,V>>
,SCOMap<java.util.HashMap<K,V>,K,V>
,BackedSCO
public class HashMap<K,V> extends HashMap<K,V> implements BackedSCO
A mutable second-class HashMap object. Backed by a MapStore object.- See Also:
- Serialized Form
-
-
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 HashMap(DNStateManager sm, AbstractMemberMetaData mmd)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Method to clear the HashMap.java.lang.Object
clone()
Creates and returns a copy of this object.boolean
containsKey(java.lang.Object key)
Method to return if the map contains this keyboolean
containsValue(java.lang.Object value)
Method to return if the map contains this value.java.util.Set
entrySet()
Accessor for the set of entries in the Map.boolean
equals(java.lang.Object o)
void
forEach(java.util.function.BiConsumer<? super K,? super V> action)
V
get(java.lang.Object key)
Accessor for the value stored against a key.Store
getBackingStore()
java.util.HashMap
getValue()
Accessor for the unwrapped value that we are wrapping.int
hashCode()
void
initialise()
Method to initialise the SCO for use.void
initialise(java.util.HashMap m)
Method to initialise the SCO from an existing value.void
initialise(java.util.HashMap newValue, java.lang.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.java.util.Set
keySet()
Accessor for the set of keys in the 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 HashMap.void
putAll(java.util.Map m)
Method to add the specified Map's values under their keys here.V
remove(java.lang.Object key)
Method to remove the value for a key from the HashMap.int
size()
Method to return the size of the Map.void
unsetOwner()
Method to unset the owner and field details.void
updateEmbeddedKey(K key, int fieldNumber, java.lang.Object newValue, boolean makeDirty)
Method to update an embedded key in this map.void
updateEmbeddedValue(V value, int fieldNumber, java.lang.Object newValue, boolean makeDirty)
Method to update an embedded value in this map.java.util.Collection
values()
Accessor for the set of values in the Map.protected java.lang.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.HashMap
attachCopy, detachCopy, getFieldName, getOwner, makeDirty, setValue
-
-
-
-
Constructor Detail
-
HashMap
public HashMap(DNStateManager sm, AbstractMemberMetaData mmd)
Constructor- Parameters:
sm
- the owner StateManagermmd
- Metadata for the member
-
-
Method Detail
-
initialise
public void initialise(java.util.HashMap newValue, java.lang.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 classHashMap<K,V>
- Parameters:
newValue
- New value (to wrap)oldValue
- Old value (to use in deciding what needs deleting etc)
-
initialise
public void initialise(java.util.HashMap m)
Method to initialise the SCO from an existing value.- Specified by:
initialise
in interfaceSCO<K>
- Overrides:
initialise
in classHashMap<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 classHashMap<K,V>
-
getValue
public java.util.HashMap 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, java.lang.Object newValue, boolean makeDirty)
Method to update an embedded key in this map.- Specified by:
updateEmbeddedKey
in interfaceSCOMap<java.util.HashMap<K,V>,K,V>
- Overrides:
updateEmbeddedKey
in classHashMap<K,V>
- Parameters:
key
- The keyfieldNumber
- Number of field in the keynewValue
- New value for this fieldmakeDirty
- Whether to make the SCO field dirty.
-
updateEmbeddedValue
public void updateEmbeddedValue(V value, int fieldNumber, java.lang.Object newValue, boolean makeDirty)
Method to update an embedded value in this map.- Specified by:
updateEmbeddedValue
in interfaceSCOMap<java.util.HashMap<K,V>,K,V>
- Overrides:
updateEmbeddedValue
in classHashMap<K,V>
- Parameters:
value
- The valuefieldNumber
- Number of field in the valuenewValue
- New value for this fieldmakeDirty
- Whether to make the SCO field dirty.
-
unsetOwner
public void unsetOwner()
Method to unset the owner and field details.- Specified by:
unsetOwner
in interfaceSCO<K>
- Overrides:
unsetOwner
in classHashMap<K,V>
-
clone
public java.lang.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(java.lang.Object key)
Method to return if the map contains this key
-
containsValue
public boolean containsValue(java.lang.Object value)
Method to return if the map contains this value.
-
entrySet
public java.util.Set entrySet()
Accessor for the set of entries in the Map.
-
equals
public boolean equals(java.lang.Object o)
-
get
public V get(java.lang.Object key)
Accessor for the value stored against a key.
-
hashCode
public int hashCode()
-
isEmpty
public boolean isEmpty()
Method to return if the Map is empty.
-
keySet
public java.util.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 java.util.Collection values()
Accessor for the set of values in the Map.
-
clear
public void clear()
Method to clear the HashMap.
-
putAll
public void putAll(java.util.Map m)
Method to add the specified Map's values under their keys here.
-
remove
public V remove(java.lang.Object key)
Method to remove the value for a key from the HashMap.
-
writeReplace
protected java.lang.Object writeReplace() throws java.io.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 classHashMap<K,V>
- Returns:
- the replaced object
- Throws:
java.io.ObjectStreamException
- if an error occurs
-
-