org.dmilne.xjsf.param

Class Parameter<T>

java.lang.Object

org.dmilne.xjsf.param.Parameter<T>

Type Parameters:

T - the type of value to expect.

Direct Known Subclasses:

BooleanParameter, EnumParameter, EnumSetParameter, FloatParameter, IntListParameter, IntParameter, StringArrayParameter, StringParameter

public abstract class Parameter<T>
extends java.lang.Object

A parameter or argument for a service. Parameters should know how to extract their value from an HttpServletRequest and document themselves as an xml description.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,java.lang.String>	valueDescriptionsByName

Constructor Summary

Constructors

Constructor and Description
Parameter(java.lang.String name, java.lang.String description, T defaultValue, java.lang.String dataTypeName) Initialises a new parameter

Method Summary

Methods

Modifier and Type	Method and Description
T	getDefaultValue() Returns the value to be used if no value is manually specified in the service request.
java.lang.String	getDescription() Returns a short textual description of what this parameter does
java.lang.String	getName() Returns the name of the parameter
abstract T	getValue(javax.servlet.http.HttpServletRequest request) Returns the value of this parameter, as specified in the given request.
java.lang.String	getValueForDescription(T val)

Methods inherited from class java.lang.Object

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

Field Detail

valueDescriptionsByName

protected java.util.HashMap<java.lang.String,java.lang.String> valueDescriptionsByName

Constructor Detail

Parameter

public Parameter(java.lang.String name,
         java.lang.String description,
         T defaultValue,
         java.lang.String dataTypeName)

Initialises a new parameter

Parameters:

name - the name of the parameter

description - a short description of what this parameter does

defaultValue - the value to use when requests do not specify a value for this parameter (may be null)

Method Detail

getName

public java.lang.String getName()

Returns the name of the parameter

Returns:

the name of the parameter

getDescription

public java.lang.String getDescription()

Returns a short textual description of what this parameter does

Returns:

a short textual description of what this parameter does

getDefaultValue

public T getDefaultValue()

Returns the value to be used if no value is manually specified in the service request. This may be null, in which case the parameter is considered mandatory: all requests to the service must specify a value for this parameter

Returns:

the value to be used if none is manually specified in the service request.

getValueForDescription

public java.lang.String getValueForDescription(T val)

getValue

public abstract T getValue(javax.servlet.http.HttpServletRequest request)
                    throws java.lang.IllegalArgumentException

Returns the value of this parameter, as specified in the given request. If the request specifies an invalid value, or none at all, then the default value will be returned.

Parameters:

request - the request made to the service

Returns:

the value of this parameter, as specified in the given request.

Throws:

java.lang.IllegalArgumentException - if the value specified in this request cannot be parsed