Class Properties
java.lang.Object
java.util.Dictionary<Object,Object>
java.util.Hashtable<Object,Object>
java.util.Properties
org.datanucleus.store.types.wrappers.Properties
org.datanucleus.store.types.wrappers.backed.Properties
- All Implemented Interfaces:
Serializable
,Cloneable
,Map<Object,
,Object> SCO<Properties>
,SCOContainer<Properties>
,SCOMap<Properties,
,Object, Object> BackedSCO
A mutable second-class Properties object. Backed by a MapStore object.
The key and value types of this class is
String
.- See Also:
-
Nested Class Summary
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
protected MapStore
protected boolean
protected boolean
Fields inherited from class org.datanucleus.store.types.wrappers.Properties
delegate, ownerMmd, ownerSM
Fields inherited from class java.util.Properties
defaults
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Method to clear the Hashtableclone()
Creates and returns a copy of this object.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.entrySet()
Accessor for the set of entries in the Map.boolean
Method to check the equality of this map, and another.Accessor for the value stored against a key.getProperty
(String key) Accessor for the string value stored against a string key.getValue()
Accessor for the unwrapped value that we are wrapping.int
hashCode()
Method to generate a hashcode for this Map.void
Method to initialise the SCO for use.void
Method to initialise the SCO from an existing value.void
initialise
(Properties 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.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
Method to load all elements from the "backing store" where appropriate.Method to add a value against a key to the Hashtablevoid
Method to add the specified Map's values under their keys here.Method to remove the value for a key from the HashtablesetProperty
(String key, String value) Method to add a string value against a string key to the Hashtableint
size()
Method to return the size of the Map.void
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.values()
Accessor for the set of values in the Map.protected Object
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.Properties
attachCopy, detachCopy, getFieldName, getOwner, makeDirty, setValue
Methods inherited from class java.util.Properties
getProperty, list, list, load, load, loadFromXML, propertyNames, save, store, store, storeToXML, storeToXML, stringPropertyNames
Methods inherited from class java.util.Hashtable
compute, computeIfAbsent, computeIfPresent, contains, elements, forEach, getOrDefault, keys, merge, putIfAbsent, rehash, remove, replace, replace, replaceAll, toString
-
Field Details
-
backingStore
-
allowNulls
protected transient boolean allowNulls -
useCache
protected transient boolean useCache -
isCacheLoaded
protected transient boolean isCacheLoaded
-
-
Constructor Details
-
Properties
Constructor- Parameters:
sm
- the owner StateManagermmd
- Metadata for the member
-
-
Method Details
-
initialise
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<Properties>
- Overrides:
initialise
in classProperties
- Parameters:
newValue
- New value (to wrap)oldValue
- Old value (to use in deciding what needs deleting etc)
-
initialise
Method to initialise the SCO from an existing value.- Specified by:
initialise
in interfaceSCO<Properties>
- Overrides:
initialise
in classProperties
- Parameters:
m
- Object to set value using.
-
initialise
public void initialise()Method to initialise the SCO for use.- Specified by:
initialise
in interfaceSCO<Properties>
- Overrides:
initialise
in classProperties
-
getValue
Accessor for the unwrapped value that we are wrapping.- Specified by:
getValue
in interfaceSCO<Properties>
- Overrides:
getValue
in classProperties
- Returns:
- The unwrapped 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<Properties>
- Overrides:
load
in classProperties
-
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.- Specified by:
isLoaded
in interfaceBackedSCO
- Specified by:
isLoaded
in interfaceSCOContainer<Properties>
- Overrides:
isLoaded
in classProperties
- Returns:
- Whether it is loaded
-
loadFromStore
protected void loadFromStore()Method to load all elements from the "backing store" where appropriate. -
getBackingStore
- Specified by:
getBackingStore
in interfaceBackedSCO
-
updateEmbeddedKey
Method to update an embedded key in this map.- Specified by:
updateEmbeddedKey
in interfaceSCOMap<Properties,
Object, Object> - Overrides:
updateEmbeddedKey
in classProperties
- Parameters:
key
- The keyfieldNumber
- Number of field in the keynewValue
- New value for this fieldmakeDirty
- Whether to make the SCO field dirty.
-
updateEmbeddedValue
Method to update an embedded value in this map.- Specified by:
updateEmbeddedValue
in interfaceSCOMap<Properties,
Object, Object> - Overrides:
updateEmbeddedValue
in classProperties
- 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<Properties>
- Overrides:
unsetOwner
in classProperties
-
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 interfaceSCO<Properties>
- Overrides:
clone
in classProperties
- Returns:
- The cloned object
-
containsKey
Method to return if the map contains this key- Specified by:
containsKey
in interfaceMap<Object,
Object> - Overrides:
containsKey
in classProperties
- Parameters:
key
- The key- Returns:
- Whether it is contained
-
containsValue
Method to return if the map contains this value.- Specified by:
containsValue
in interfaceMap<Object,
Object> - Overrides:
containsValue
in classProperties
- Parameters:
value
- The value- Returns:
- Whether it is contained
-
entrySet
Accessor for the set of entries in the Map. -
equals
Method to check the equality of this map, and another. -
get
Accessor for the value stored against a key. -
getProperty
Accessor for the string value stored against a string key.- Overrides:
getProperty
in classProperties
- Parameters:
key
- The key- Returns:
- The value.
-
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
Accessor for the set of keys in the Map. -
size
public int size()Method to return the size of the Map. -
values
Accessor for the set of values in the Map. -
clear
public void clear()Method to clear the Hashtable -
put
Method to add a value against a key to the Hashtable -
putAll
Method to add the specified Map's values under their keys here. -
remove
Method to remove the value for a key from the Hashtable -
setProperty
Method to add a string value against a string key to the Hashtable- Overrides:
setProperty
in classProperties
- Parameters:
key
- The keyvalue
- The value- Returns:
- The previous value for the specified key.
-
writeReplace
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 classProperties
- Returns:
- the replaced object
- Throws:
ObjectStreamException
- if an error occurs
-