org.omnifaces.component

Interface ParamHolder

All Superinterfaces:

javax.faces.component.ValueHolder

All Known Implementing Classes:

Param, SimpleParam

public interface ParamHolder
extends javax.faces.component.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 converted value. This is used in among others the Faces.getBookmarkableURL(String, java.util.Collection, boolean).

Since:

1.7

Author:

Bauke Scholtz

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getLocalValue() Returns the original, unconverted value of the parameter.
java.lang.String	getName() Returns the name of the parameter.
java.lang.Object	getValue() Returns the converted value of the parameter.

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, setConverter, setValue

Method Detail

getName

java.lang.String getName()

Returns the name of the parameter.

Returns:

The name of the parameter.

getLocalValue

java.lang.Object getLocalValue()

Returns the original, unconverted value of the parameter.

Specified by:

getLocalValue in interface javax.faces.component.ValueHolder

Returns:

The original, unconverted value of the parameter.

getValue

java.lang.Object getValue()

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 javax.faces.component.ValueHolder

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)