jakarta.faces.webapp

Class ConverterELTag

java.lang.Object

jakarta.servlet.jsp.tagext.TagSupport

jakarta.faces.webapp.ConverterELTag

All Implemented Interfaces:

IterationTag, JspTag, Tag, Serializable

public abstract class ConverterELTag
extends TagSupport

ConverterELTag is a base class for all Jakarta Server Pages 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 UIComponentClassicTagBase. 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 as a base class for tag instances that support specific Converter subclasses.

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.

See Also:

Serialized Form

Field Summary

Fields inherited from class jakarta.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface jakarta.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface jakarta.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
ConverterELTag()

Method Summary

Modifier and Type	Method and Description
protected abstract Converter	createConverter() Create and return a new Converter to be registered on our surrounding UIComponent.
int	doStartTag() Create a new instance of the specified Converter class, and register it with the UIComponent instance associated with our most immediately surrounding UIComponentClassicTagBase instance, if the UIComponent instance was created by this execution of the containing Jakarta Server Pages page.

Methods inherited from class jakarta.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

ConverterELTag

public ConverterELTag()

Method Detail

doStartTag

public int doStartTag()
               throws JspException

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

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class TagSupport

Returns:

SKIP_BODY

Throws:

JspException - if a Jakarta Server Pages error occurs

See Also:

Tag.doStartTag()

createConverter

protected abstract Converter createConverter()
                                      throws JspException

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

Returns:

the Converter

Throws:

JspException - if a new instance cannot be created