org.datanucleus.store.types.wrappers.backed

Class Properties

java.lang.Object

java.util.Dictionary<K,V>

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

public class Properties
extends Properties
implements BackedSCO

A mutable second-class Properties object. Backed by a MapStore object. The key and value types of this class is String.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowNulls
protected MapStore	backingStore
protected boolean	isCacheLoaded
protected boolean	useCache

Fields inherited from class org.datanucleus.store.types.wrappers.Properties

delegate, ownerMmd, ownerOP

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
Properties(ObjectProvider op, AbstractMemberMetaData mmd) Constructor

Method Summary

Modifier and Type	Method and Description
void	clear() Method to clear the Hashtable
Object	clone() Creates and returns a copy of this object.
boolean	containsKey(Object key) Method to return if the map contains this key
boolean	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.
Object	get(Object key) Accessor for the value stored against a key.
Store	getBackingStore()
String	getProperty(String key) Accessor for the string value stored against a string key.
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.
void	initialise(Properties m) 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.
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.
Object	put(Object key, Object value) Method to add a value against a key to the Hashtable
void	putAll(Map m) Method to add the specified Map's values under their keys here.
Object	remove(Object key) Method to remove the value for a key from the Hashtable
Object	setProperty(String key, String value) Method to add a string value against a string key to the Hashtable
int	size() Method to return the size of the Map.
void	unsetOwner() 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.
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.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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

backingStore

protected transient MapStore backingStore

allowNulls

protected transient boolean allowNulls

useCache

protected transient boolean useCache

isCacheLoaded

protected transient boolean isCacheLoaded

Constructor Detail

Properties

public Properties(ObjectProvider op,
                  AbstractMemberMetaData mmd)

Constructor

Parameters:

op - the owner of this Map

mmd - Metadata for the member

Method Detail

initialise

public void initialise(Properties 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 interface SCO<Properties>

Overrides:

initialise in class Properties

Parameters:

newValue - New value (to wrap)

oldValue - Old value (to use in deciding what needs deleting etc)

initialise

public void initialise(Properties m)

Method to initialise the SCO from an existing value.

Specified by:

initialise in interface SCO<Properties>

Overrides:

initialise in class Properties

Parameters:

m - Object to set value using.

initialise

public void initialise()

Method to initialise the SCO for use.

Specified by:

initialise in interface SCO<Properties>

Overrides:

initialise in class Properties

getValue

public Properties getValue()

Accessor for the unwrapped value that we are wrapping.

Specified by:

getValue in interface SCO<Properties>

Overrides:

getValue in class Properties

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 interface SCOContainer<Properties>

Overrides:

load in class Properties

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 interface SCOContainer<Properties>

Overrides:

isLoaded in class Properties

Returns:

Whether it is loaded

loadFromStore

protected void loadFromStore()

Method to load all elements from the "backing store" where appropriate.

getBackingStore

public Store getBackingStore()

Specified by:

getBackingStore in interface BackedSCO

updateEmbeddedKey

public void updateEmbeddedKey(Object key,
                              int fieldNumber,
                              Object newValue,
                              boolean makeDirty)

Method to update an embedded key in this map.

Specified by:

updateEmbeddedKey in interface SCOMap<Properties,Object,Object>

Overrides:

updateEmbeddedKey in class Properties

Parameters:

key - The key

fieldNumber - Number of field in the key

newValue - New value for this field

makeDirty - Whether to make the SCO field dirty.

updateEmbeddedValue

public void updateEmbeddedValue(Object value,
                                int fieldNumber,
                                Object newValue,
                                boolean makeDirty)

Method to update an embedded value in this map.

Specified by:

updateEmbeddedValue in interface SCOMap<Properties,Object,Object>

Overrides:

updateEmbeddedValue in class Properties

Parameters:

value - The value

fieldNumber - Number of field in the value

newValue - New value for this field

makeDirty - Whether to make the SCO field dirty.

unsetOwner

public void unsetOwner()

Method to unset the owner and field details.

Specified by:

unsetOwner in interface SCO<Properties>

Overrides:

unsetOwner in class Properties

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.

Specified by:

clone in interface SCO<Properties>

Overrides:

clone in class Properties

Returns:

The cloned object

containsKey

public boolean containsKey(Object key)

Method to return if the map contains this key

Specified by:

containsKey in interface Map<Object,Object>

Overrides:

containsKey in class Properties

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 interface Map<Object,Object>

Overrides:

containsValue in class Properties

Parameters:

value - The value

Returns:

Whether it is contained

entrySet

public Set entrySet()

Accessor for the set of entries in the Map.

Specified by:

entrySet in interface Map<Object,Object>

Overrides:

entrySet in class Properties

Returns:

Set of entries

equals

public boolean equals(Object o)

Method to check the equality of this map, and another.

Specified by:

equals in interface Map<Object,Object>

Overrides:

equals in class Properties

Parameters:

o - The map to compare against.

Returns:

Whether they are equal.

get

public Object get(Object key)

Accessor for the value stored against a key.

Specified by:

get in interface Map<Object,Object>

Overrides:

get in class Properties

Parameters:

key - The key

Returns:

The value.

getProperty

public String getProperty(String key)

Accessor for the string value stored against a string key.

Overrides:

getProperty in class Properties

Parameters:

key - The key

Returns:

The value.

hashCode

public int hashCode()

Method to generate a hashcode for this Map.

Specified by:

hashCode in interface Map<Object,Object>

Overrides:

hashCode in class Properties

Returns:

The hashcode.

isEmpty

public boolean isEmpty()

Method to return if the Map is empty.

Specified by:

isEmpty in interface Map<Object,Object>

Overrides:

isEmpty in class Properties

Returns:

Whether it is empty.

keySet

public Set keySet()

Accessor for the set of keys in the Map.

Specified by:

keySet in interface Map<Object,Object>

Overrides:

keySet in class Properties

Returns:

Set of keys.

size

public int size()

Method to return the size of the Map.

Specified by:

size in interface Map<Object,Object>

Overrides:

size in class Properties

Returns:

The size

values

public Collection values()

Accessor for the set of values in the Map.

Specified by:

values in interface Map<Object,Object>

Overrides:

values in class Properties

Returns:

Set of values.

clear

public void clear()

Method to clear the Hashtable

Specified by:

clear in interface Map<Object,Object>

Overrides:

clear in class Properties

put

public Object put(Object key,
                  Object value)

Method to add a value against a key to the Hashtable

Specified by:

put in interface Map<Object,Object>

Overrides:

put in class Properties

Parameters:

key - The key

value - The value

Returns:

The previous value for the specified key.

putAll

public void putAll(Map m)

Method to add the specified Map's values under their keys here.

Specified by:

putAll in interface Map<Object,Object>

Overrides:

putAll in class Properties

Parameters:

m - The map

remove

public Object remove(Object key)

Method to remove the value for a key from the Hashtable

Specified by:

remove in interface Map<Object,Object>

Overrides:

remove in class Properties

Parameters:

key - The key to remove

Returns:

The value that was removed from this key.

setProperty

public Object setProperty(String key,
                          String value)

Method to add a string value against a string key to the Hashtable

Overrides:

setProperty in class Properties

Parameters:

key - The key

value - The value

Returns:

The previous value for the specified key.

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 class Properties

Returns:

the replaced object

Throws:

ObjectStreamException - if an error occurs