|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An interface to represent a list of parameter name-value pairs.
All comparisons using String
s are done in a case
insensitive (but retentive) manner.
ParameterListDescriptor
Method Summary | |
boolean |
getBooleanParameter(String paramName)
A convenience method to return a parameter as a boolean . |
byte |
getByteParameter(String paramName)
A convenience method to return a parameter as a byte . |
char |
getCharParameter(String paramName)
A convenience method to return a parameter as a char . |
double |
getDoubleParameter(String paramName)
A convenience method to return a parameter as a double . |
float |
getFloatParameter(String paramName)
A convenience method to return a parameter as a float . |
int |
getIntParameter(String paramName)
A convenience method to return a parameter as an int . |
long |
getLongParameter(String paramName)
A convenience method to return a parameter as a long . |
Object |
getObjectParameter(String paramName)
Gets a named parameter as an Object . |
ParameterListDescriptor |
getParameterListDescriptor()
Returns the associated ParameterListDescriptor . |
short |
getShortParameter(String paramName)
A convenience method to return a parameter as a short . |
ParameterList |
setParameter(String paramName,
boolean b)
Sets a named parameter to a boolean value. |
ParameterList |
setParameter(String paramName,
byte b)
Sets a named parameter to a byte value. |
ParameterList |
setParameter(String paramName,
char c)
Sets a named parameter to a char value. |
ParameterList |
setParameter(String paramName,
double d)
Sets a named parameter to a double value. |
ParameterList |
setParameter(String paramName,
float f)
Sets a named parameter to a float value. |
ParameterList |
setParameter(String paramName,
int i)
Sets a named parameter to an int value. |
ParameterList |
setParameter(String paramName,
long l)
Sets a named parameter to a long value. |
ParameterList |
setParameter(String paramName,
Object obj)
Sets a named parameter to an Object value. |
ParameterList |
setParameter(String paramName,
short s)
Sets a named parameter to a short value. |
Method Detail |
public ParameterListDescriptor getParameterListDescriptor()
ParameterListDescriptor
.
public ParameterList setParameter(String paramName, byte b)
byte
value.
Implementing classes are free but not required to check class type,
ranges, and enumeration types.
paramName
- a String
naming a parameter.b
- a byte
value for the parameter.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.public ParameterList setParameter(String paramName, boolean b)
boolean
value.
Implementing classes are free but not required to check class type,
ranges, and enumeration types.
paramName
- a String
naming a parameter.b
- a boolean
value for the parameter.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.public ParameterList setParameter(String paramName, char c)
char
value.
Implementing classes are free but not required to check class type,
ranges, and enumeration types.
paramName
- a String
naming a parameter.c
- a char
value for the parameter.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.public ParameterList setParameter(String paramName, short s)
short
value.
Implementing classes are free but not required to check class type,
ranges, and enumeration types.
paramName
- a String
naming a parameter.s
- a short
value for the parameter.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.public ParameterList setParameter(String paramName, int i)
int
value.
Implementing classes are free but not required to check class type,
ranges, and enumeration types.
paramName
- a String
naming a parameter.i
- an int
value for the parameter.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.public ParameterList setParameter(String paramName, long l)
long
value.
Implementing classes are free but not required to check class type,
ranges, and enumeration types.
paramName
- a String
naming a parameter.l
- a long
value for the parameter.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.public ParameterList setParameter(String paramName, float f)
float
value.
Implementing classes are free but not required to check class type,
ranges, and enumeration types.
paramName
- a String
naming a parameter.f
- a float
value for the parameter.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.public ParameterList setParameter(String paramName, double d)
double
value.
Implementing classes are free but not required to check class type,
ranges, and enumeration types.
paramName
- a String
naming a parameter.d
- a double
value for the parameter.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.public ParameterList setParameter(String paramName, Object obj)
Object
value.
Implementing classes are free but not required to check class type,
ranges, and enumeration types.
paramName
- a String
naming a parameter.obj
- an Object
value for the parameter.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.
pointed to by the paramName.public Object getObjectParameter(String paramName)
Object
. Parameters
belonging to a primitive type, such as int, will be returned as a
member of the corresponding wrapper class, such as
Integer
.
paramName
- the name of the parameter to be returned.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.
IllegalStateException
- if the parameter value is still
ParameterListDescriptor.NO_PARAMETER_DEFAULTpublic byte getByteParameter(String paramName)
byte
.
paramName
- the name of the parameter to be returned.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.
ClassCastException
- if the parameter is of a different type.
IllegalStateException
- if the parameter value is still
ParameterListDescriptor.NO_PARAMETER_DEFAULTpublic boolean getBooleanParameter(String paramName)
boolean
.
paramName
- the name of the parameter to be returned.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.
ClassCastException
- if the parameter is of a different type.
IllegalStateException
- if the parameter value is still
ParameterListDescriptor.NO_PARAMETER_DEFAULTpublic char getCharParameter(String paramName)
char
.
paramName
- the name of the parameter to be returned.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.
ClassCastException
- if the parameter is of a different type.
IllegalStateException
- if the parameter value is still
ParameterListDescriptor.NO_PARAMETER_DEFAULTpublic short getShortParameter(String paramName)
short
.
paramName
- the name of the parameter to be returned.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.
ClassCastException
- if the parameter is of a different type.
IllegalStateException
- if the parameter value is still
ParameterListDescriptor.NO_PARAMETER_DEFAULTpublic int getIntParameter(String paramName)
int
.
paramName
- the name of the parameter to be returned.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.
ClassCastException
- if the parameter is of a different type.
IllegalStateException
- if the parameter value is still
ParameterListDescriptor.NO_PARAMETER_DEFAULTpublic long getLongParameter(String paramName)
long
.
paramName
- the name of the parameter to be returned.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.
ClassCastException
- if the parameter is of a different type.
IllegalStateException
- if the parameter value is still
ParameterListDescriptor.NO_PARAMETER_DEFAULTpublic float getFloatParameter(String paramName)
float
.
paramName
- the name of the parameter to be returned.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.
ClassCastException
- if the parameter is of a different type.
IllegalStateException
- if the parameter value is still
ParameterListDescriptor.NO_PARAMETER_DEFAULTpublic double getDoubleParameter(String paramName)
double
.
paramName
- the name of the parameter to be returned.
IllegalArgumentException
- if paramName is null.
IllegalArgumentException
- if there is no parameter with the
specified name.
ClassCastException
- if the parameter is of a different type.
IllegalStateException
- if the parameter value is still
ParameterListDescriptor.NO_PARAMETER_DEFAULT
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |