com.sun.faces.taglib.jsf_core

Class ConverterTag.BindingConverter

java.lang.Object

com.sun.faces.taglib.jsf_core.ConverterTag.BindingConverter

All Implemented Interfaces:

jakarta.faces.component.StateHolder, jakarta.faces.convert.Converter

Enclosing class:

ConverterTag

public static class ConverterTag.BindingConverter
extends Object
implements jakarta.faces.convert.Converter, jakarta.faces.component.StateHolder

Field Summary

Fields inherited from interface jakarta.faces.convert.Converter

DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE_PARAM_NAME

Constructor Summary

Constructors

Constructor and Description
BindingConverter() This is only used during state restoration.
BindingConverter(jakarta.el.ValueExpression converterId, jakarta.el.ValueExpression binding)

Method Summary

Modifier and Type	Method and Description
Object	getAsObject(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component, String value) Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle.
String	getAsString(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component, Object value) Convert the specified model object value, which is associated with the specified UIComponent, into a String that is suitable for being included in the response generated during the Render Response phase of the request processing lifeycle.
boolean	isTransient() If true, the Object implementing this interface must not participate in state saving or restoring.
void	restoreState(jakarta.faces.context.FacesContext context, Object state) Perform any processing required to restore the state from the entries in the state Object.
Object	saveState(jakarta.faces.context.FacesContext context) Gets the state of the instance as a Serializable Object.
void	setTransient(boolean newTransientValue) Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.

Methods inherited from class java.lang.Object

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

Constructor Detail

BindingConverter

public BindingConverter()

This is only used during state restoration.

BindingConverter

public BindingConverter(jakarta.el.ValueExpression converterId,
                        jakarta.el.ValueExpression binding)

Method Detail

getAsObject

public Object getAsObject(jakarta.faces.context.FacesContext context,
                          jakarta.faces.component.UIComponent component,
                          String value)

Description copied from interface: jakarta.faces.convert.Converter

Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle.

Specified by:

getAsObject in interface jakarta.faces.convert.Converter

Parameters:

context - FacesContext for the request being processed

component - UIComponent with which this model object value is associated

value - String value to be converted (may be null)

Returns:

null if the value to convert is null, otherwise the result of the conversion

getAsString

public String getAsString(jakarta.faces.context.FacesContext context,
                          jakarta.faces.component.UIComponent component,
                          Object value)

Description copied from interface: jakarta.faces.convert.Converter

Convert the specified model object value, which is associated with the specified UIComponent, into a String that is suitable for being included in the response generated during the Render Response phase of the request processing lifeycle.

Specified by:

getAsString in interface jakarta.faces.convert.Converter

Parameters:

context - FacesContext for the request being processed

component - UIComponent with which this model object value is associated

value - Model object value to be converted (may be null)

Returns:

a zero-length String if value is null, otherwise the result of the conversion

saveState

public Object saveState(jakarta.faces.context.FacesContext context)

Description copied from interface: jakarta.faces.component.StateHolder

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.saveState(jakarta.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets. That is done via the StateManager

This method must not alter the state of the implementing object. In other words, after executing this code:

 
 Object state = component.saveState(facesContext);
 
 

component should be the same as before executing it.

The return from this method must be Serializable

Specified by:

saveState in interface jakarta.faces.component.StateHolder

Parameters:

context - the Faces context.

Returns:

the saved state.

restoreState

public void restoreState(jakarta.faces.context.FacesContext context,
                         Object state)

Description copied from interface: jakarta.faces.component.StateHolder

Perform any processing required to restore the state from the entries in the state Object.

If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.restoreState(jakarta.faces.context.FacesContext, java.lang.Object) method on all those instances as well.

If the state argument is null, take no action and return.

Specified by:

restoreState in interface jakarta.faces.component.StateHolder

Parameters:

context - the Faces context.

state - the state.

isTransient

public boolean isTransient()

Description copied from interface: jakarta.faces.component.StateHolder

If true, the Object implementing this interface must not participate in state saving or restoring.

Specified by:

isTransient in interface jakarta.faces.component.StateHolder

Returns:

true if transient, false otherwise.

setTransient

public void setTransient(boolean newTransientValue)

Description copied from interface: jakarta.faces.component.StateHolder

Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.

Specified by:

setTransient in interface jakarta.faces.component.StateHolder

Parameters:

newTransientValue - boolean pass true if this Object will not participate in state saving or restoring, otherwise pass false.