Class Properties
- java.lang.Object
-
- java.util.Dictionary<K,V>
-
- java.util.Hashtable<java.lang.Object,java.lang.Object>
-
- java.util.Properties
-
- org.datanucleus.store.types.wrappers.Properties
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.util.Map<java.lang.Object,java.lang.Object>
,SCO<java.util.Properties>
,SCOContainer<java.util.Properties>
,SCOMap<java.util.Properties,java.lang.Object,java.lang.Object>
- Direct Known Subclasses:
Properties
public class Properties extends java.util.Properties implements SCOMap<java.util.Properties,java.lang.Object,java.lang.Object>
A mutable second-class Properties 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
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Properties
delegate
The internal "delegate".protected AbstractMemberMetaData
ownerMmd
protected DNStateManager
ownerSM
-
Constructor Summary
Constructors Constructor Description Properties(DNStateManager sm, AbstractMemberMetaData mmd)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
attachCopy(java.util.Properties value)
Method to return an attached copy of the passed (detached) value.void
clear()
Method to clear the Hashtablejava.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.Properties
detachCopy(FetchPlanState state)
Method to return a detached copy of the container.java.util.Set
entrySet()
Accessor for the set of entries in the Map.boolean
equals(java.lang.Object o)
Method to check the equality of this map, and another.java.lang.Object
get(java.lang.Object key)
Accessor for the value stored against a key.java.lang.String
getFieldName()
Accessor for the field name that this Hashtable relates to.java.lang.Object
getOwner()
Accessor for the owner that this Hashtable relates to.java.util.Properties
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(java.util.Properties m)
Method to initialise the SCO for use with the provided initial value.void
initialise(java.util.Properties 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.void
makeDirty()
Utility to mark the object as dirtyjava.lang.Object
put(java.lang.Object key, java.lang.Object value)
Method to add a value against a key to the Hashtablevoid
putAll(java.util.Map m)
Method to add the specified Map's values under their keys here.java.lang.Object
remove(java.lang.Object key)
Method to remove the value for a key from the Hashtablejava.lang.Object
setProperty(java.lang.String key, java.lang.String value)
Method to add a string value against a string key to the Hashtablevoid
setValue(java.util.Properties 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 details.void
updateEmbeddedKey(java.lang.Object key, int fieldNumber, java.lang.Object newValue, boolean makeDirty)
Method to update an embedded key in this map.void
updateEmbeddedValue(java.lang.Object 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 java.util.Properties
getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, store, store, storeToXML, storeToXML, stringPropertyNames
-
-
-
-
Field Detail
-
ownerSM
protected transient DNStateManager ownerSM
-
ownerMmd
protected transient AbstractMemberMetaData ownerMmd
-
delegate
protected java.util.Properties delegate
The internal "delegate".
-
-
Constructor Detail
-
Properties
public Properties(DNStateManager sm, AbstractMemberMetaData mmd)
Constructor- Parameters:
sm
- the owner of this Mapmmd
- Metadata for the member
-
-
Method Detail
-
initialise
public void initialise(java.util.Properties 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<java.util.Properties>
- Parameters:
newValue
- New value (to wrap)oldValue
- Old value (to use in deciding what needs deleting etc)
-
initialise
public void initialise(java.util.Properties 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<java.util.Properties>
- 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<java.util.Properties>
-
getValue
public java.util.Properties getValue()
Accessor for the unwrapped value that we are wrapping.
-
setValue
public void setValue(java.util.Properties value)
Description copied from interface:SCOContainer
Method to change the delegate value this wraps (to save recreating the wrapper).- Specified by:
setValue
in interfaceSCOContainer<java.util.Properties>
- 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<java.util.Properties>
-
isLoaded
public boolean isLoaded()
Method to return if the SCO has its contents loaded. Returns true.- Specified by:
isLoaded
in interfaceSCOContainer<java.util.Properties>
- Returns:
- Whether it is loaded
-
updateEmbeddedKey
public void updateEmbeddedKey(java.lang.Object 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.Properties,java.lang.Object,java.lang.Object>
- 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(java.lang.Object 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.Properties,java.lang.Object,java.lang.Object>
- Parameters:
value
- The valuefieldNumber
- Number of field in the valuenewValue
- New value for this fieldmakeDirty
- Whether to make the SCO field dirty.
-
getFieldName
public java.lang.String getFieldName()
Accessor for the field name that this Hashtable relates to.- Specified by:
getFieldName
in interfaceSCO<java.util.Properties>
- Returns:
- The field name
-
getOwner
public java.lang.Object getOwner()
Accessor for the owner that this Hashtable relates to.
-
unsetOwner
public void unsetOwner()
Method to unset the owner and field details.- Specified by:
unsetOwner
in interfaceSCO<java.util.Properties>
-
makeDirty
public void makeDirty()
Utility to mark the object as dirty
-
detachCopy
public java.util.Properties 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<java.util.Properties>
- Parameters:
state
- State for detachment process- Returns:
- The detached container
-
attachCopy
public void attachCopy(java.util.Properties 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<java.util.Properties>
- Parameters:
value
- The new (map) value
-
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- Specified by:
containsKey
in interfacejava.util.Map<java.lang.Object,java.lang.Object>
- Overrides:
containsKey
in classjava.util.Hashtable<java.lang.Object,java.lang.Object>
- Parameters:
key
- The key- Returns:
- Whether it is contained
-
containsValue
public boolean containsValue(java.lang.Object value)
Method to return if the map contains this value.- Specified by:
containsValue
in interfacejava.util.Map<java.lang.Object,java.lang.Object>
- Overrides:
containsValue
in classjava.util.Hashtable<java.lang.Object,java.lang.Object>
- Parameters:
value
- The value- Returns:
- Whether it is contained
-
entrySet
public java.util.Set entrySet()
Accessor for the set of entries in the Map.- Specified by:
entrySet
in interfacejava.util.Map<java.lang.Object,java.lang.Object>
- Overrides:
entrySet
in classjava.util.Hashtable<java.lang.Object,java.lang.Object>
- Returns:
- Set of entries
-
equals
public boolean equals(java.lang.Object o)
Method to check the equality of this map, and another.- Specified by:
equals
in interfacejava.util.Map<java.lang.Object,java.lang.Object>
- Overrides:
equals
in classjava.util.Hashtable<java.lang.Object,java.lang.Object>
- Parameters:
o
- The map to compare against.- Returns:
- Whether they are equal.
-
get
public java.lang.Object get(java.lang.Object key)
Accessor for the value stored against a key.- Specified by:
get
in interfacejava.util.Map<java.lang.Object,java.lang.Object>
- Overrides:
get
in classjava.util.Hashtable<java.lang.Object,java.lang.Object>
- Parameters:
key
- The key- Returns:
- The value.
-
hashCode
public int hashCode()
Method to generate a hashcode for this Map.- Specified by:
hashCode
in interfacejava.util.Map<java.lang.Object,java.lang.Object>
- Overrides:
hashCode
in classjava.util.Hashtable<java.lang.Object,java.lang.Object>
- Returns:
- The hashcode.
-
isEmpty
public boolean isEmpty()
Method to return if the Map is empty.- Specified by:
isEmpty
in interfacejava.util.Map<java.lang.Object,java.lang.Object>
- Overrides:
isEmpty
in classjava.util.Hashtable<java.lang.Object,java.lang.Object>
- Returns:
- Whether it is empty.
-
keySet
public java.util.Set keySet()
Accessor for the set of keys in the Map.- Specified by:
keySet
in interfacejava.util.Map<java.lang.Object,java.lang.Object>
- Overrides:
keySet
in classjava.util.Hashtable<java.lang.Object,java.lang.Object>
- Returns:
- Set of keys.
-
size
public int size()
Method to return the size of the Map.- Specified by:
size
in interfacejava.util.Map<java.lang.Object,java.lang.Object>
- Overrides:
size
in classjava.util.Hashtable<java.lang.Object,java.lang.Object>
- Returns:
- The size
-
values
public java.util.Collection values()
Accessor for the set of values in the Map.- Specified by:
values
in interfacejava.util.Map<java.lang.Object,java.lang.Object>
- Overrides:
values
in classjava.util.Hashtable<java.lang.Object,java.lang.Object>
- Returns:
- Set of values.
-
clear
public void clear()
Method to clear the Hashtable- Specified by:
clear
in interfacejava.util.Map<java.lang.Object,java.lang.Object>
- Overrides:
clear
in classjava.util.Hashtable<java.lang.Object,java.lang.Object>
-
put
public java.lang.Object put(java.lang.Object key, java.lang.Object value)
Method to add a value against a key to the Hashtable- Specified by:
put
in interfacejava.util.Map<java.lang.Object,java.lang.Object>
- Overrides:
put
in classjava.util.Hashtable<java.lang.Object,java.lang.Object>
- Parameters:
key
- The keyvalue
- The value- Returns:
- The previous value for the specified key.
-
putAll
public void putAll(java.util.Map m)
Method to add the specified Map's values under their keys here.- Specified by:
putAll
in interfacejava.util.Map<java.lang.Object,java.lang.Object>
- Overrides:
putAll
in classjava.util.Hashtable<java.lang.Object,java.lang.Object>
- Parameters:
m
- The map
-
remove
public java.lang.Object remove(java.lang.Object key)
Method to remove the value for a key from the Hashtable- Specified by:
remove
in interfacejava.util.Map<java.lang.Object,java.lang.Object>
- Overrides:
remove
in classjava.util.Hashtable<java.lang.Object,java.lang.Object>
- Parameters:
key
- The key to remove- Returns:
- The value that was removed from this key.
-
setProperty
public java.lang.Object setProperty(java.lang.String key, java.lang.String value)
Method to add a string value against a string key to the Hashtable- Overrides:
setProperty
in classjava.util.Properties
- Parameters:
key
- The keyvalue
- The value- Returns:
- The previous value for the specified key.
-
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.- Returns:
- the replaced object
- Throws:
java.io.ObjectStreamException
- if an error occurs
-
-