org.jwarp.service.param
Class Parameters

java.lang.Object
  |
  +--org.jwarp.service.param.Parameters

public class Parameters

extends java.lang.Object

Class encapsulating a set of parameters for passing as parameter and for accessing the single entities.

Field Summary

(package private) java.util.Hashtable

params The parameters stored in this instance.

Constructor Summary

Parameters()
Creates a new parameters object.

Method Summary

IParameter	addParameter(IParameter param) Adds a new parameter to this object.
boolean	contains(java.lang.String paramName)
IParameterDescription	getMetaData(java.lang.String name) Returns the current metadata of the parameter.
IParameter	getParameter(java.lang.String name) Returns the parameter with the given name or null
java.lang.Object	getParameter(java.lang.String name, java.lang.Object defaultValue) Retrieve the String value of the specified parameter.
boolean	getParameterAsBoolean(java.lang.String name)
boolean	getParameterAsBoolean(java.lang.String name, boolean defaultValue) Retrieve the boolean value of the specified parameter.
double	getParameterAsDouble(java.lang.String name)
double	getParameterAsDouble(java.lang.String name, double defaultValue) Retrieve the float value of the specified parameter.
float	getParameterAsFloat(java.lang.String name)
float	getParameterAsFloat(java.lang.String name, float defaultValue) Retrieve the float value of the specified parameter.
int	getParameterAsInteger(java.lang.String name)
int	getParameterAsInteger(java.lang.String name, int defaultValue) Retrieve the int value of the specified parameter.
long	getParameterAsLong(java.lang.String name)
long	getParameterAsLong(java.lang.String name, long defaultValue) Retrieve the long value of the specified parameter.
java.lang.String	getParameterAsString(java.lang.String name)
java.lang.String	getParameterAsString(java.lang.String name, java.lang.String defaultValue) Retrieve the String value of the specified parameter.
java.util.Iterator	getParameters() Returns an iterator with all parameters.
java.lang.Object	getValue(java.lang.String name) Returns the current value of the parameter.
Parameters	merge(Parameters other) Merge parameters from another Parameters instance into this.
void	removeParameter(IParameter param) Removes the parameter given.
IParameter	removeParameter(java.lang.String name) Removes the parameter given.
void	setValue(java.lang.String name, java.lang.Object value) Sets the current value of the parameter.
void	validate()

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

params

java.util.Hashtable params

The parameters stored in this instance.

Constructor Detail

Parameters

public Parameters()

Creates a new parameters object.

Method Detail

addParameter

public IParameter addParameter(IParameter param)

Adds a new parameter to this object. If a parameter with the same name existed yet it will be returned as result of this method.

Parameters:

param - The new parameter

Returns:

The previous such named parameter, if any

removeParameter

public void removeParameter(IParameter param)

Removes the parameter given.

Parameters:

The - parameter's instance to be removed.

removeParameter

public IParameter removeParameter(java.lang.String name)

Removes the parameter given.

Parameters:

The - parameter's name to be removed.

getParameter

public IParameter getParameter(java.lang.String name)

Returns the parameter with the given name or null

Parameters:

The - parameter's name

Returns:

The parameter instance or null

getParameters

public java.util.Iterator getParameters()

Returns an iterator with all parameters.

Returns:

All parameters

getValue

public java.lang.Object getValue(java.lang.String name)
                          throws NotFoundException

Returns the current value of the parameter. This is the same as calling getParameter(name).getValue().

Parameters:

name - The parameter's name

Returns:

The params value

Throws:

NotFoundException - if the parameter does not exist

setValue

public void setValue(java.lang.String name,
                     java.lang.Object value)
              throws NotFoundException,
                     ParameterException

Sets the current value of the parameter. This is the same as calling getParameter(name).setValue(value).

Parameters:

name - The parameter's name

value - The nwe value

Throws:

NotFoundException - if the parameter does not exist

ParameterException - If the validation of the new value failed.

getMetaData

public IParameterDescription getMetaData(java.lang.String name)
                                  throws NotFoundException

Returns the current metadata of the parameter. This is the same as calling getParameter(name).getMetaData().

Parameters:

name - The parameter's name

Returns:

The params value

Throws:

NotFoundException - if the parameter does not exist

validate

public void validate()
              throws ParameterException

contains

public boolean contains(java.lang.String paramName)

getParameter

public java.lang.Object getParameter(java.lang.String name,
                                     java.lang.Object defaultValue)

Retrieve the String value of the specified parameter.

If the specified parameter cannot be found, defaultValue is returned.

getParameterAsInteger

public int getParameterAsInteger(java.lang.String name,
                                 int defaultValue)

Retrieve the int value of the specified parameter.

If the specified parameter cannot be found, defaultValue is returned.

getParameterAsLong

public long getParameterAsLong(java.lang.String name,
                               long defaultValue)

Retrieve the long value of the specified parameter.

If the specified parameter cannot be found, defaultValue is returned.

getParameterAsFloat

public float getParameterAsFloat(java.lang.String name,
                                 float defaultValue)

Retrieve the float value of the specified parameter.

If the specified parameter cannot be found, defaultValue is returned.

getParameterAsDouble

public double getParameterAsDouble(java.lang.String name,
                                   double defaultValue)

Retrieve the float value of the specified parameter.

If the specified parameter cannot be found, defaultValue is returned.

getParameterAsBoolean

public boolean getParameterAsBoolean(java.lang.String name,
                                     boolean defaultValue)

Retrieve the boolean value of the specified parameter.

If the specified parameter cannot be found, defaultValue is returned.

getParameterAsString

public java.lang.String getParameterAsString(java.lang.String name,
                                             java.lang.String defaultValue)

Retrieve the String value of the specified parameter.

If the specified parameter cannot be found, defaultValue is returned.

getParameterAsBoolean

public boolean getParameterAsBoolean(java.lang.String name)

getParameterAsString

public java.lang.String getParameterAsString(java.lang.String name)

getParameterAsInteger

public int getParameterAsInteger(java.lang.String name)

getParameterAsLong

public long getParameterAsLong(java.lang.String name)

getParameterAsFloat

public float getParameterAsFloat(java.lang.String name)

getParameterAsDouble

public double getParameterAsDouble(java.lang.String name)

merge

public Parameters merge(Parameters other)

Merge parameters from another Parameters instance into this.

Returns:

This Parameters instance.