Package jakarta.servlet.jsp.tagext
Class TagAdapter
- java.lang.Object
-
- jakarta.servlet.jsp.tagext.TagAdapter
-
public class TagAdapter extends java.lang.Object implements Tag
Wraps any SimpleTag and exposes it using a Tag interface. This is used to allow collaboration between classic Tag handlers and SimpleTag handlers.Because SimpleTag does not extend Tag, and because Tag.setParent() only accepts a Tag instance, a classic tag handler (one that implements Tag) cannot have a SimpleTag as its parent. To remedy this, a TagAdapter is created to wrap the SimpleTag parent, and the adapter is passed to setParent() instead. A classic Tag Handler can call getAdaptee() to retrieve the encapsulated SimpleTag instance.
- Since:
- JSP 2.0
-
-
Field Summary
-
Fields inherited from interface jakarta.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
-
-
Constructor Summary
Constructors Constructor Description TagAdapter(SimpleTag adaptee)Creates a new TagAdapter that wraps the given SimpleTag and returns the parent tag when getParent() is called.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intdoEndTag()Must not be called.intdoStartTag()Must not be called.JspTaggetAdaptee()Gets the tag that is being adapted to the Tag interface.TaggetParent()Returns the parent of this tag, which is always getAdaptee().getParent().voidrelease()Must not be called.voidsetPageContext(PageContext pc)Must not be called.voidsetParent(Tag parentTag)Must not be called.
-
-
-
Constructor Detail
-
TagAdapter
public TagAdapter(SimpleTag adaptee)
Creates a new TagAdapter that wraps the given SimpleTag and returns the parent tag when getParent() is called.- Parameters:
adaptee- The SimpleTag being adapted as a Tag.
-
-
Method Detail
-
setPageContext
public void setPageContext(PageContext pc)
Must not be called.- Specified by:
setPageContextin interfaceTag- Parameters:
pc- ignored.- Throws:
java.lang.UnsupportedOperationException- Must not be called
-
setParent
public void setParent(Tag parentTag)
Must not be called. The parent of this tag is always getAdaptee().getParent().
-
getParent
public Tag getParent()
Returns the parent of this tag, which is always getAdaptee().getParent(). This will either be the enclosing Tag (if getAdaptee().getParent() implements Tag), or an adapter to the enclosing Tag (if getAdaptee().getParent() does not implement Tag).- Specified by:
getParentin interfaceTag- Returns:
- The parent of the tag being adapted.
- See Also:
TagSupport.findAncestorWithClass(jakarta.servlet.jsp.tagext.Tag, java.lang.Class<?>)
-
getAdaptee
public JspTag getAdaptee()
Gets the tag that is being adapted to the Tag interface. This should be an instance of SimpleTag in JSP 2.0, but room is left for other kinds of tags in future spec versions.- Returns:
- the tag that is being adapted
-
doStartTag
public int doStartTag() throws JspExceptionMust not be called.- Specified by:
doStartTagin interfaceTag- Returns:
- always throws UnsupportedOperationException
- Throws:
java.lang.UnsupportedOperationException- Must not be calledJspException- never thrown- See Also:
BodyTag
-
doEndTag
public int doEndTag() throws JspExceptionMust not be called.- Specified by:
doEndTagin interfaceTag- Returns:
- always throws UnsupportedOperationException
- Throws:
java.lang.UnsupportedOperationException- Must not be calledJspException- never thrown
-
-