fm.liveswitch.Dynamic Class Referenceabstract

Supplies class instances with a key-value mapping to support dynamic property storage. More...

Public Member Functions

java.util.HashMap< String, Object > getDynamicProperties ()
 Gets all dynamic properties on this instance. More...
 
Object getDynamicValue (String key)
 Gets a property value from the local cache. More...
 
void setDynamicValue (String key, Object value)
 Sets a property value in the local cache. More...
 
boolean unsetDynamicValue (String key)
 Removes a property value from the local cache. More...
 

Protected Member Functions

 Dynamic ()
 
- Protected Member Functions inherited from fm.liveswitch.Serializable
boolean getIsDirty ()
 Gets a value indicating whether this instance is dirty. More...
 
 Serializable ()
 Initializes a new instance of the fm.liveswitch.Serializable class. More...
 
void setIsDirty (boolean value)
 Sets a value indicating whether this instance is dirty. More...
 

Detailed Description

Supplies class instances with a key-value mapping to support dynamic property storage.

Constructor & Destructor Documentation

◆ Dynamic()

fm.liveswitch.Dynamic.Dynamic ( )
protected

Member Function Documentation

◆ getDynamicProperties()

java.util.HashMap<String,Object> fm.liveswitch.Dynamic.getDynamicProperties ( )

Gets all dynamic properties on this instance.

◆ getDynamicValue()

Object fm.liveswitch.Dynamic.getDynamicValue ( String  key)

Gets a property value from the local cache.

Parameters
keyThe property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.
Returns
The stored value, if found; otherwise null.

◆ setDynamicValue()

void fm.liveswitch.Dynamic.setDynamicValue ( String  key,
Object  value 
)

Sets a property value in the local cache.

Parameters
keyThe property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.
valueThe property value. This can be any object that needs to be stored for future use.

◆ unsetDynamicValue()

boolean fm.liveswitch.Dynamic.unsetDynamicValue ( String  key)

Removes a property value from the local cache.

Returns true if the value was removed and returns false otherwise.

Parameters
keyThe property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.
Returns
true
if the value was removed; otherwise,
false
.