com.arsdigita.bebop.parameters
Class BooleanParameter

java.lang.Object
  extended bycom.arsdigita.bebop.parameters.ParameterModel
      extended bycom.arsdigita.bebop.parameters.BooleanParameter
All Implemented Interfaces:
Lockable

public class BooleanParameter
extends ParameterModel

A class that represents the model for boolean form parameters.

Version:
$Id: //core-platform/dev/src/com/arsdigita/bebop/parameters/BooleanParameter.java#7 $
Author:
Karl Goldstein, Uday Mathur

Field Summary
static String versionId
           
 
Fields inherited from class com.arsdigita.bebop.parameters.ParameterModel
m_defaultValue, m_locked, m_name, m_parameterListeners
 
Constructor Summary
BooleanParameter(String name)
           
 
Method Summary
 Class getValueClass()
          Return the class that all values produced by the model will have.
 Object transformValue(javax.servlet.http.HttpServletRequest request)
          Transform string parameter values in the HTTP request into an appropriate Java object associated with the particular implementing class.
 Object unmarshal(String encoded)
          Reconstruct the parameter value from an encoded string produced by marshal.
 
Methods inherited from class com.arsdigita.bebop.parameters.ParameterModel
addParameterListener, createParameterData, createParameterData, createParameterData, getDefaultOverridesNull, getDefaultValue, getName, isLocked, isPassIn, lock, marshal, setDefaultOverridesNull, setDefaultValue, setName, setPassIn, transformSingleValue, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values
Constructor Detail

BooleanParameter

public BooleanParameter(String name)
Method Detail

transformValue

public Object transformValue(javax.servlet.http.HttpServletRequest request)
Description copied from class: ParameterModel
Transform string parameter values in the HTTP request into an appropriate Java object associated with the particular implementing class. If there is an error transforming the passed-in URL/form variables into a Java object, then implementing classes should throw IllegalArgumentException.

Specified by:
transformValue in class ParameterModel
Parameters:
request - The HttpServletRequest of the form submission.

unmarshal

public Object unmarshal(String encoded)
Description copied from class: ParameterModel
Reconstruct the parameter value from an encoded string produced by marshal. This is an optional operation, which needs to be implemented by specific subclasses; this implementation just throws an UnsupportedOperationException.

The contract between marshal and unmarshal is that for any possible object obj this parameter model can produce obj.equals(unmarshal(marshal(obj)).

Overrides:
unmarshal in class ParameterModel
Parameters:
encoded - a string produced by marshal
Returns:
the object represented by encoded

getValueClass

public Class getValueClass()
Description copied from class: ParameterModel
Return the class that all values produced by the model will have. This should be the most specific common base class of all classes of which the model will ever produce values. This implementation returns Object.class

Overrides:
getValueClass in class ParameterModel
Returns:
the class that all values produced by the model will have.


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC