org.dmilne.xjsf.param

Class StringParameter

java.lang.Object

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

org.dmilne.xjsf.param.StringParameter

public class StringParameter
extends Parameter<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(String name, String description, String defaultValue) Initialises a new (case sensitive) StringParameter
StringParameter(String name, String description, String defaultValue, boolean caseSensitive) Initialises a new StringParameter

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultValue() Returns the value to be used if no value is manually specified in the service request.
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

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(String name,
               String description,
               String defaultValue)

Initialises a new (case sensitive) 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)

StringParameter

public StringParameter(String name,
               String description,
               String defaultValue,
               boolean caseSensitive)

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)

caseSensitive - true if you care about capitalisation of values

Method Detail

getValue

public String getValue(javax.servlet.http.HttpServletRequest request)
                throws 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<String>

Parameters:

request - the request made to the service

Returns:

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

Throws:

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

getDefaultValue

public String getDefaultValue()

Description copied from class: Parameter

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

Overrides:

getDefaultValue in class Parameter<String>

Returns:

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