org.omnifaces.component

Class SimpleParam

java.lang.Object

org.omnifaces.component.SimpleParam

All Implemented Interfaces:

ValueHolder, ParamHolder

public class SimpleParam
extends Object
implements ParamHolder

This class provides a basic and default implementation of the ParamHolder interface. Ultimately, this class can be used as a simple key-value pair holder (parameter name-value) which uses an explicit/implicit JSF converter to convert the object value to string.

Since:

1.7

Author:

Bauke Scholtz

Constructor Summary

Constructors

Constructor and Description
SimpleParam() Default constructor.
SimpleParam(ParamHolder param) Construct a simple param with name, value and converter of given ParamHolder instance.
SimpleParam(String name, Object value) Construct a simple param with name and value.
SimpleParam(String name, Object value, Converter converter) Construct a simple param with name, value and converter.
SimpleParam(UIParameter param) Construct a simple param with name and value of given UIParameter component.

Method Summary

Modifier and Type	Method and Description
Converter	getConverter()
Object	getLocalValue() Returns the original, unconverted value of the parameter.
String	getName() Returns the name of the parameter.
Object	getValue() Returns the converted value of the parameter.
void	setConverter(Converter converter)
void	setName(String name) Sets the parameter name.
void	setValue(Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleParam

public SimpleParam()

Default constructor.

SimpleParam

public SimpleParam(String name,
                   Object value)

Construct a simple param with name and value.

Parameters:

name - The parameter name.

value - The parameter value.

SimpleParam

public SimpleParam(String name,
                   Object value,
                   Converter converter)

Construct a simple param with name, value and converter.

Parameters:

name - The parameter name.

value - The parameter value.

converter - The converter.

SimpleParam

public SimpleParam(UIParameter param)

Construct a simple param with name and value of given UIParameter component.

Parameters:

param - The UIParameter to copy.

Since:

2.2

SimpleParam

public SimpleParam(ParamHolder param)

Construct a simple param with name, value and converter of given ParamHolder instance.

Parameters:

param - The ParamHolder to copy.

Since:

2.2

Method Detail

getName

public String getName()

Description copied from interface: ParamHolder

Returns the name of the parameter.

Specified by:

getName in interface ParamHolder

Returns:

The name of the parameter.

setName

public void setName(String name)

Sets the parameter name.

Parameters:

name - The parameter name.

getLocalValue

public Object getLocalValue()

Description copied from interface: ParamHolder

Returns the original, unconverted value of the parameter.

Specified by:

getLocalValue in interface ValueHolder

Specified by:

getLocalValue in interface ParamHolder

Returns:

The original, unconverted value of the parameter.

getValue

public Object getValue()

Description copied from interface: ParamHolder

Returns the converted value of the parameter. If the converter is set, or if any converter is available by Application.createConverter(Class), passing the value's class, then return the result of Converter.getAsString(javax.faces.context.FacesContext, javax.faces.component.UIComponent, Object), otherwise return the original value of the parameter.

Specified by:

getValue in interface ValueHolder

Specified by:

getValue in interface ParamHolder

Returns:

The converted value of the parameter, or the original value if the converter is not available.

See Also:

Converter.getAsString(javax.faces.context.FacesContext, javax.faces.component.UIComponent, Object)

setValue

public void setValue(Object value)

Specified by:

setValue in interface ValueHolder

getConverter

public Converter getConverter()

Specified by:

getConverter in interface ValueHolder

setConverter

public void setConverter(Converter converter)

Specified by:

setConverter in interface ValueHolder