org.dmilne.xjsf.param

Class EnumParameter<T extends java.lang.Enum<T>>

java.lang.Object

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

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

Type Parameters:

T - the expected enum type

public class EnumParameter<T extends java.lang.Enum<T>>
extends Parameter<T>

A Parameter that expects enum values. The values must match the enum

Field Summary

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

valueDescriptionsByName

Constructor Summary

Constructors

Constructor and Description
EnumParameter(java.lang.String name, java.lang.String description, T defaultValue, T[] allValues, java.lang.String[] valueDescriptions) Initialises a new EnumParameter

Method Summary

Methods

Modifier and Type	Method and Description
T	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

EnumParameter

public EnumParameter(java.lang.String name,
             java.lang.String description,
             T defaultValue,
             T[] allValues,
             java.lang.String[] valueDescriptions)

Initialises a new EnumParameter

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)

allValues - a list of all values for this enum

valueDescriptions - an array of short descriptions for each possible value

Method Detail

getValue

public T 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<T extends java.lang.Enum<T>>

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