Module org.omnifaces

Package org.omnifaces.component

Interface ParamHolder<T>

Type Parameters:

T - The type of the value.

All Superinterfaces:

ValueHolder

All Known Implementing Classes:

Param, PathParam, SimpleParam

public interface ParamHolder<T>
extends ValueHolder

This interface represents a (request) parameter holder which extends ValueHolder with getName() method to obtain the parameter name associated with the parameter value and changes the getLocalValue() method to return the original, unconverted value and changes the getValue() method to return the value converted to String. This is used in among others the Faces.getBookmarkableURL(String, java.util.Collection, boolean).

Since:

1.7

Author:

Bauke Scholtz

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.

Methods inherited from interface jakarta.faces.component.ValueHolder

setConverter, setValue

Method Details

getName

String getName()

Returns the name of the parameter.

Returns:

The name of the parameter.

getLocalValue

T getLocalValue()

Returns the original, unconverted value of the parameter.

Specified by:

getLocalValue in interface ValueHolder

Returns:

The original, unconverted value of the parameter.

getConverter

Converter<T> getConverter()

Returns the converter, if any.

Specified by:

getConverter in interface ValueHolder

Returns:

The converter, if any.

getValue

String getValue()

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 ValueHolder

Returns:

The value of the parameter as String.

See Also:

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