org.milyn.cdr

Class Parameter

java.lang.Object

org.milyn.cdr.Parameter

public class Parameter
extends Object

SmooksResourceConfiguration Parameter.

Wrapper for a param. Handles decoding.

Author:

tfennelly

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_TYPE_PREFIX

Constructor Summary

Constructors

Constructor and Description
Parameter(String name, Object value) Public constructor.
Parameter(String name, String value) Public constructor.
Parameter(String name, String value, String type) Public constructor.

Method Summary

Modifier and Type	Method and Description
String	getName() Get the parameter name.
Object	getObjValue() Get the object value associated with this parameter.
String	getType() Get the parameter type.
String	getValue() Get the parameter value "undecoded".
Object	getValue(ContentDeliveryConfig deliveryConfig) Get the parameter value "decoded" into an Object.
Element	getXml() Get the DOM element node associated with the parameter definition.
Parameter	setXML(Element xml) Set the DOM element node associated with the parameter definition.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_TYPE_PREFIX

public static final String PARAM_TYPE_PREFIX

See Also:

Constant Field Values

Constructor Detail

Parameter

public Parameter(String name,
                 String value)

Public constructor.

Parameters:

name - Parameter name.

value - Parameter value.

Parameter

public Parameter(String name,
                 Object value)

Public constructor.

Parameters:

name - Parameter name.

value - Parameter value.

Parameter

public Parameter(String name,
                 String value,
                 String type)

Public constructor.

Parameters:

name - Parameter name.

value - Parameter value.

type - Parameter type. This argument identifies the ParameterDecoder to use for decoding the param value.

Method Detail

getName

public String getName()

Get the parameter name.

Returns:

The parameter name.

getType

public String getType()

Get the parameter type.

Returns:

The parameter type.

getValue

public String getValue()

Get the parameter value "undecoded".

Returns:

Parameter value.

getValue

public Object getValue(ContentDeliveryConfig deliveryConfig)
                throws ParameterDecodeException

Get the parameter value "decoded" into an Object.

Uses the supplied deliveryConfig to get the ParameterDecoder implementation to be used to decode the parameter value. Looks up the ParameterDecoder using the parameter type - selector="decoder-<type>".

Parameters:

deliveryConfig - Requesting device ContentDeliveryConfig.

Returns:

Decoded value.

Throws:

ParameterDecodeException - Unable to decode parameter value.

getObjValue

public Object getObjValue()

Get the object value associated with this parameter.

Returns:

The object value, or null if not set.

toString

public String toString()

Overrides:

toString in class Object

setXML

public Parameter setXML(Element xml)

Set the DOM element node associated with the parameter definition.

Only relevant for XML based configs.

Parameters:

xml - Parameter configuration xml.

getXml

public Element getXml()

Get the DOM element node associated with the parameter definition.

Only relevant for XML based configs.

Returns:

Parameter configuration xml.