Class ConverterELTag
- java.lang.Object
-
- jakarta.servlet.jsp.tagext.TagSupport
-
- jakarta.faces.webapp.ConverterELTag
-
- All Implemented Interfaces:
IterationTag
,JspTag
,Tag
,java.io.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 theValueHolder
associated with our most immediate surrounding instance of a tag whose implementation class is a subclass ofUIComponentClassicTagBase
. To avoid creating duplicate instances when a page is redisplayed, creation and registration of aConverter
occurs only if the correspondingUIComponent
was created (by the owningUIComponentTag
) 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 aConverter
instance. Any configuration properties that specify behavior of thisConverter
must have been set by thecreateConverter()
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 Description ConverterELTag()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract Converter
createConverter()
Create and return a newConverter
to be registered on our surroundingUIComponent
.int
doStartTag()
Create a new instance of the specifiedConverter
class, and register it with theUIComponent
instance associated with our most immediately surroundingUIComponentClassicTagBase
instance, if theUIComponent
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
-
-
-
-
Method Detail
-
doStartTag
public int doStartTag() throws JspException
Create a new instance of the specified
Converter
class, and register it with theUIComponent
instance associated with our most immediately surroundingUIComponentClassicTagBase
instance, if theUIComponent
instance was created by this execution of the containing Jakarta Server Pages page. If the localValue of theUIComponent
is a String, attempt to convert it.- Specified by:
doStartTag
in interfaceTag
- Overrides:
doStartTag
in classTagSupport
- 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 surroundingUIComponent
.- Returns:
- the
Converter
- Throws:
JspException
- if a new instance cannot be created
-
-