com.jbbres.lib.actions.elements
Class Parameters

java.lang.Object
  extended by java.util.Dictionary<K,V>
      extended by java.util.Hashtable<java.lang.Object,java.lang.Object>
          extended by java.util.Properties
              extended by com.jbbres.lib.actions.elements.Parameters
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>
Direct Known Subclasses:
VariableActionParameters

public class Parameters
extends java.util.Properties

Represents a persistent set of data that can be associated to an Element (an action or a variable for example). The Parameters can be saved to or loaded from a stream. Each key and its corresponding value in the parameter list is a string.

Parameters is a subclass of java.util.Properties and provides similar functionalities.

Because Parameters inherits from Hashtable, the put(Object, Object) and putAll(java.util.Map) methods can be applied to a Parameters object. Their use is strongly discouraged as they allow the caller to insert entries whose keys or values are not Strings. The setParameter(String, String) or any other setParameter(String, ...) method should be used instead. If the store or save method is called on a "compromised" Parameter object that contains a non- String key or value, the call will fail. Similarly, the call to the propertyNames or list method will fail if it is called on a "compromised" Parameters object that contains a non- String key.

Since:
1.0.0
Version:
1.0.0
Author:
Jean-Baptiste Bres
See Also:
Serialized Form

Constructor Summary
Parameters()
          Instantiates a new empty parameters list with no default values.
Parameters(java.util.Properties defaults)
          Instantiates a new empty parameters list with the specified defaults.
 
Method Summary
 boolean getBooleanParameter(java.lang.String key)
          Similar to Boolean.valueOf(getProperty(key));
 double getDoubleParameter(java.lang.String key)
          Similar to Double.valueOf(getProperty(key)).doubleValue();
 float getFloatParameter(java.lang.String key)
          Similar to Float.valueOf(getProperty(key)).floatValue();
 int getIntParameter(java.lang.String key)
          Similar to Integer.valueOf(getProperty(key)).intValue();
 long getLongParameter(java.lang.String key)
          Similar to Long.valueOf(getProperty(key)).longValue();
 java.lang.String getParameter(java.lang.String key)
          Searches for the parameter with the specified key in this parameter list.
 void setParameter(java.lang.String key, boolean value)
          Similar to setParameter(key, Boolean.toString(value))
 void setParameter(java.lang.String key, double value)
          Similar to setParameter(key, Double.toString(value))
 void setParameter(java.lang.String key, float value)
          Similar to setParameter(key, Float.toString(value))
 void setParameter(java.lang.String key, int value)
          Similar to setParameter(key, Integer.toString(value))
 void setParameter(java.lang.String key, long value)
          Similar to setParameter(key, Long.toString(value))
 void setParameter(java.lang.String key, java.lang.String value)
          Calls the Hashtable method put.
 
Methods inherited from class java.util.Properties
getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames
 
Methods inherited from class java.util.Hashtable
clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, remove, size, toString, values
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Parameters

public Parameters()
Instantiates a new empty parameters list with no default values.


Parameters

public Parameters(java.util.Properties defaults)
Instantiates a new empty parameters list with the specified defaults.

Parameters:
defaults - - the default values.
Method Detail

getParameter

public java.lang.String getParameter(java.lang.String key)
Searches for the parameter with the specified key in this parameter list. If the key is not found in this parameter list, the default parameter list and its defaults, recursively, are then checked. The method returns null if the parameter is not found.

Parameters:
key - - the parameter key.
Returns:
the value in this parameter list with the specified key value.
See Also:
setParameter(String, String)

setParameter

public void setParameter(java.lang.String key,
                         java.lang.String value)
Calls the Hashtable method put. Provided for parallelism with the getProperties method. Enforces use of strings for parameter keys and values. The value returned is the result of the Hashtable call to put.

Parameters:
key - - the key to be placed into this parameter list.
value - - the value corresponding to key.
See Also:
getParameter(String), Properties.defaults

getIntParameter

public int getIntParameter(java.lang.String key)
Similar to Integer.valueOf(getProperty(key)).intValue();

Parameters:
key - - the parameter key.
Returns:
the value in this parameter list with the specified key value.
See Also:
setParameter(String, int)

setParameter

public void setParameter(java.lang.String key,
                         int value)
Similar to setParameter(key, Integer.toString(value))

Parameters:
key - the key to be placed into this parameter list.
value - the value corresponding to key.
See Also:
getIntParameter(String)

getLongParameter

public long getLongParameter(java.lang.String key)
Similar to Long.valueOf(getProperty(key)).longValue();

Parameters:
key - - the parameter key.
Returns:
the value in this parameter list with the specified key value.
See Also:
setParameter(String, long)

setParameter

public void setParameter(java.lang.String key,
                         long value)
Similar to setParameter(key, Long.toString(value))

Parameters:
key - the key to be placed into this parameter list.
value - the value corresponding to key.
See Also:
getLongParameter(String)

getDoubleParameter

public double getDoubleParameter(java.lang.String key)
Similar to Double.valueOf(getProperty(key)).doubleValue();

Parameters:
key - - the parameter key.
Returns:
the value in this parameter list with the specified key value.
See Also:
setParameter(String, double)

setParameter

public void setParameter(java.lang.String key,
                         double value)
Similar to setParameter(key, Double.toString(value))

Parameters:
key - the key to be placed into this parameter list.
value - the value corresponding to key.
See Also:
getDoubleParameter(String)

getFloatParameter

public float getFloatParameter(java.lang.String key)
Similar to Float.valueOf(getProperty(key)).floatValue();

Parameters:
key - - the parameter key.
Returns:
the value in this parameter list with the specified key value.
See Also:
setParameter(String, float)

setParameter

public void setParameter(java.lang.String key,
                         float value)
Similar to setParameter(key, Float.toString(value))

Parameters:
key - the key to be placed into this parameter list.
value - the value corresponding to key.
See Also:
getFloatParameter(String)

getBooleanParameter

public boolean getBooleanParameter(java.lang.String key)
Similar to Boolean.valueOf(getProperty(key));

Parameters:
key - - the parameter key.
Returns:
the value in this parameter list with the specified key value.
See Also:
setParameter(String, boolean)

setParameter

public void setParameter(java.lang.String key,
                         boolean value)
Similar to setParameter(key, Boolean.toString(value))

Parameters:
key - the key to be placed into this parameter list.
value - the value corresponding to key.
See Also:
getBooleanParameter(String)


To file bugs or suggest feature enhancements, visit the app.jbbres.com Bug Reporter website.

Additional documentation available online at http://app.jbbres.com/actions/developers.

Copyright � 2009-2011 app.jbbres.com. All Rights Reserved.