Module org.omnifaces

Package org.omnifaces.component

Class SimpleParam<T>

java.lang.Object

org.omnifaces.component.SimpleParam<T>

Type Parameters:

T - The type of the value.

All Implemented Interfaces:

ValueHolder, ParamHolder<T>

public class SimpleParam<T>
extends Object
implements ParamHolder<T>

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 Faces converter to convert the object value to string.

Since:

1.7

Author:

Bauke Scholtz

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Converter<T>	getConverter()	Returns the converter, if any.
T	getLocalValue()	Returns the original, unconverted value of the parameter.
String	getName()	Returns the name of the parameter.
String	getValue()	Returns the value of the parameter as String.
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,
                   T value)

Construct a simple param with name and value.

Parameters:

name - The parameter name.

value - The parameter value.

SimpleParam

public SimpleParam(String name,
                   T value,
                   Converter<T> 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.

Throws:

ClassCastException - When actual parameter value is not T.

Since:

2.2

SimpleParam

public SimpleParam(ParamHolder<T> 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<T>

Returns:

The name of the parameter.

setName

public void setName(String name)

Sets the parameter name.

Parameters:

name - The parameter name.

getLocalValue

public T getLocalValue()

Description copied from interface: ParamHolder

Returns the original, unconverted value of the parameter.

Specified by:

getLocalValue in interface ParamHolder<T>

Specified by:

getLocalValue in interface ValueHolder

Returns:

The original, unconverted value of the parameter.

getValue

public String getValue()

Description copied from interface: ParamHolder

Returns the value of the parameter as String. 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(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, Object), otherwise return the Object.toString() of the value.

Specified by:

getValue in interface ParamHolder<T>

Specified by:

getValue in interface ValueHolder

Returns:

The value of the parameter as String.

See Also:

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

setValue

public void setValue(Object value)

Specified by:

setValue in interface ValueHolder

Throws:

ClassCastException - When actual value is not T.

getConverter

public Converter<T> getConverter()

Description copied from interface: ParamHolder

Returns the converter, if any.

Specified by:

getConverter in interface ParamHolder<T>

Specified by:

getConverter in interface ValueHolder

Returns:

The converter, if any.

setConverter

public void setConverter(Converter converter)

Specified by:

setConverter in interface ValueHolder