|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.Dictionary<K,V> java.util.Hashtable<java.lang.Object,java.lang.Object> java.util.Properties com.jbbres.lib.actions.elements.Parameters
public class Parameters
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.
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 |
---|
public Parameters()
public Parameters(java.util.Properties defaults)
defaults
- - the default values.Method Detail |
---|
public java.lang.String getParameter(java.lang.String key)
null
if the parameter is not found.
key
- - the parameter key.
setParameter(String, String)
public void setParameter(java.lang.String key, java.lang.String value)
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
.
key
- - the key to be placed into this parameter list.value
- - the value corresponding to key.getParameter(String)
,
Properties.defaults
public int getIntParameter(java.lang.String key)
Integer.valueOf(getProperty(key)).intValue()
;
key
- - the parameter key.
setParameter(String, int)
public void setParameter(java.lang.String key, int value)
setParameter(key, Integer.toString(value))
key
- the key to be placed into this parameter list.value
- the value corresponding to key.getIntParameter(String)
public long getLongParameter(java.lang.String key)
Long.valueOf(getProperty(key)).longValue()
;
key
- - the parameter key.
setParameter(String, long)
public void setParameter(java.lang.String key, long value)
setParameter(key, Long.toString(value))
key
- the key to be placed into this parameter list.value
- the value corresponding to key.getLongParameter(String)
public double getDoubleParameter(java.lang.String key)
Double.valueOf(getProperty(key)).doubleValue()
;
key
- - the parameter key.
setParameter(String, double)
public void setParameter(java.lang.String key, double value)
setParameter(key, Double.toString(value))
key
- the key to be placed into this parameter list.value
- the value corresponding to key.getDoubleParameter(String)
public float getFloatParameter(java.lang.String key)
Float.valueOf(getProperty(key)).floatValue()
;
key
- - the parameter key.
setParameter(String, float)
public void setParameter(java.lang.String key, float value)
setParameter(key, Float.toString(value))
key
- the key to be placed into this parameter list.value
- the value corresponding to key.getFloatParameter(String)
public boolean getBooleanParameter(java.lang.String key)
Boolean.valueOf(getProperty(key))
;
key
- - the parameter key.
setParameter(String, boolean)
public void setParameter(java.lang.String key, boolean value)
setParameter(key, Boolean.toString(value))
key
- the key to be placed into this parameter list.value
- the value corresponding to key.getBooleanParameter(String)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |