Top Description Fields Constructors Methods
javax.faces.webapp

public Class ConverterTag

extends TagSupport
Class Inheritance
Imports
javax.el.ValueExpression, javax.faces.component.UIComponent, .ValueHolder, javax.faces.context.FacesContext, javax.faces.convert.Converter, .ConverterException, javax.servlet.jsp.JspException, javax.servlet.jsp.tagext.TagSupport

Deprecated

This has been partially replaced by ConverterELTag. The remainder of the functionality, namely, the binding facility and the implementation of the createConverter method, is now an implementation detail.

ConverterTag is a base class for all JSP custom actions that create and register a Converter instance on the ValueHolder associated with our most immediate surrounding instance of a tag whose implementation class is a subclass of UIComponentTag. To avoid creating duplicate instances when a page is redisplayed, creation and registration of a Converter occurs only if the corresponding UIComponent was created (by the owning UIComponentTag) during the execution of the current page.

This class may be used directly to implement a generic converter registration tag (based on the converter-id specified by the converterId attribute), or as a base class for tag instances that support specific Converter subclasses. This converterId attribute must refer to one of the well known converter-ids, or a custom converter-id as defined in a faces-config.xml file.

Subclasses of this class must implement the createConverter() method, which creates and returns a Converter instance. Any configuration properties that specify behavior of this Converter must have been set by the createConverter() method. Generally, this occurs by copying corresponding attribute values on the tag instance.

This tag creates no output to the page currently being created. It is used solely for the side effect of Converter creation.

Field Summary

Modifier and TypeField and Description
private String
binding

The ValueExpression that evaluates to an object that implements Converter.

private String
converterId

The identifier of the Converter instance to be created.

private static final long
serialVersionUID

Inherited from javax.servlet.jsp.tagext.TagSupport:
idpageContext

Constructor Summary

AccessConstructor and Description
public
ConverterTag()

Method Summary

Modifier and TypeMethod and Description
protected Converter<T>

Returns:

the Converter
createConverter()

Create and return a new Converter to be registered on our surrounding UIComponent.

public int
doStartTag()

Overrides javax.servlet.jsp.tagext.TagSupport.doStartTag.

Implements javax.servlet.jsp.tagext.Tag.doStartTag.

Create a new instance of the specified Converter class, and register it with the UIComponent instance associated with our most immediately surrounding UIComponentTag instance, if the UIComponent instance was created by this execution of the containing JSP page.

public void
release()

Overrides javax.servlet.jsp.tagext.TagSupport.release.

Implements javax.servlet.jsp.tagext.Tag.release.

Release references to any acquired resources.

public void
setBinding(String
The new expression
binding)

Set the expression that will be used to create a ValueExpression that references a backing bean property of the Converter instance to be created.

public void
setConverterId(String
The identifier of the converter instance to be created.
converterId)

Set the identifer of the Converter instance to be created.

Inherited from javax.servlet.jsp.tagext.TagSupport:
doAfterBodydoEndTagfindAncestorWithClassgetIdgetParentgetValuegetValuesremoveValuesetIdsetPageContextsetParentsetValue

Field Detail

bindingback to summary
private String binding

The ValueExpression that evaluates to an object that implements Converter.

converterIdback to summary
private String converterId

The identifier of the Converter instance to be created.

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

ConverterTagback to summary
public ConverterTag()

Method Detail

createConverterback to summary
protected Converter<T> createConverter() throws JspException

Create and return a new Converter to be registered on our surrounding UIComponent.

Returns:Converter<T>

the Converter

Exceptions
JspException:
if a new instance cannot be created
doStartTagback to summary
public int doStartTag() throws JspException

Overrides javax.servlet.jsp.tagext.TagSupport.doStartTag.

Implements javax.servlet.jsp.tagext.Tag.doStartTag.

Create a new instance of the specified Converter class, and register it with the UIComponent instance associated with our most immediately surrounding UIComponentTag instance, if the UIComponent instance was created by this execution of the containing JSP page. If the localValue of the UIComponent is a String, attempt to convert it.

Returns:int

Doc from javax.servlet.jsp.tagext.TagSupport.doStartTag.

SKIP_BODY

Annotations
@Override
Exceptions
JspException:
if a JSP error occurs
releaseback to summary
public void release()

Overrides javax.servlet.jsp.tagext.TagSupport.release.

Implements javax.servlet.jsp.tagext.Tag.release.

Release references to any acquired resources.

Annotations
@Override
setBindingback to summary
public void setBinding(String binding) throws JspException

Set the expression that will be used to create a ValueExpression that references a backing bean property of the Converter instance to be created.

Parameters
binding:String

The new expression

Exceptions
JspException:
if a JSP error occurs
setConverterIdback to summary
public void setConverterId(String converterId)

Set the identifer of the Converter instance to be created.

Parameters
converterId:String

The identifier of the converter instance to be created.