org.dmilne.xjsf.param

Class StringParameter

java.lang.Object

org.dmilne.xjsf.param.Parameter<java.lang.String>

org.dmilne.xjsf.param.StringParameter

public class StringParameter
extends Parameter<java.lang.String>

A Parameter that expects String values

Field Summary

Fields inherited from class org.dmilne.xjsf.param.Parameter

valueDescriptionsByName

Constructor Summary

Constructors

Constructor and Description
StringParameter(java.lang.String name, java.lang.String description, java.lang.String defaultValue) Initialises a new StringParameter

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getValue(javax.servlet.http.HttpServletRequest request) Returns the value of this parameter, as specified in the given request.

Methods inherited from class org.dmilne.xjsf.param.Parameter

getDefaultValue, getDescription, getName, getValueForDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

StringParameter

public StringParameter(java.lang.String name,
               java.lang.String description,
               java.lang.String defaultValue)

Initialises a new StringParameter

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

getValue

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

Description copied from class: Parameter

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.

Specified by:

getValue in class Parameter<java.lang.String>

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