org.dmilne.xjsf.param

Class BooleanParameter

java.lang.Object

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

org.dmilne.xjsf.param.BooleanParameter

public class BooleanParameter
extends Parameter<java.lang.Boolean>

A Parameter whose values are booleans

If requests specify the parameter name but not a value (e.g "serviceName?getImages") then we assume the value is true. Otherwise, this ignores case variations, and can parse 'true','false','t' or 'f'

Field Summary

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

valueDescriptionsByName

Constructor Summary

Constructors

Constructor and Description
BooleanParameter(java.lang.String name, java.lang.String description, java.lang.Boolean defaultValue) Initialises a new boolean parameter

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	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

BooleanParameter

public BooleanParameter(java.lang.String name,
                java.lang.String description,
                java.lang.Boolean defaultValue)

Initialises a new boolean 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

getValue

public java.lang.Boolean getValue(javax.servlet.http.HttpServletRequest request)

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.Boolean>

Parameters:

request - the request made to the service

Returns:

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