blob: 04239655d04289287b2aa537f3d2a7d1dc8031f9 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>TagAdapter</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TagAdapter";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html" title="interface in jakarta.servlet.jsp.tagext"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../jakarta/servlet/jsp/tagext/TagAttributeInfo.html" title="class in jakarta.servlet.jsp.tagext"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jakarta/servlet/jsp/tagext/TagAdapter.html" target="_top">Frames</a></li>
<li><a href="TagAdapter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">jakarta.servlet.jsp.tagext</div>
<h2 title="Class TagAdapter" class="title">Class TagAdapter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>jakarta.servlet.jsp.tagext.TagAdapter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../jakarta/servlet/jsp/tagext/JspTag.html" title="interface in jakarta.servlet.jsp.tagext">JspTag</a>, <a href="../../../../jakarta/servlet/jsp/tagext/Tag.html" title="interface in jakarta.servlet.jsp.tagext">Tag</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">TagAdapter</span>
extends java.lang.Object
implements <a href="../../../../jakarta/servlet/jsp/tagext/Tag.html" title="interface in jakarta.servlet.jsp.tagext">Tag</a></pre>
<div class="block">Wraps any SimpleTag and exposes it using a Tag interface. This is used to allow collaboration between classic Tag
handlers and SimpleTag handlers.
<p>
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.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>JSP 2.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.jakarta.servlet.jsp.tagext.Tag">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;jakarta.servlet.jsp.tagext.<a href="../../../../jakarta/servlet/jsp/tagext/Tag.html" title="interface in jakarta.servlet.jsp.tagext">Tag</a></h3>
<code><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html#EVAL_BODY_INCLUDE">EVAL_BODY_INCLUDE</a>, <a href="../../../../jakarta/servlet/jsp/tagext/Tag.html#EVAL_PAGE">EVAL_PAGE</a>, <a href="../../../../jakarta/servlet/jsp/tagext/Tag.html#SKIP_BODY">SKIP_BODY</a>, <a href="../../../../jakarta/servlet/jsp/tagext/Tag.html#SKIP_PAGE">SKIP_PAGE</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../jakarta/servlet/jsp/tagext/TagAdapter.html#TagAdapter-jakarta.servlet.jsp.tagext.SimpleTag-">TagAdapter</a></span>(<a href="../../../../jakarta/servlet/jsp/tagext/SimpleTag.html" title="interface in jakarta.servlet.jsp.tagext">SimpleTag</a>&nbsp;adaptee)</code>
<div class="block">Creates a new TagAdapter that wraps the given SimpleTag and returns the parent tag when getParent() is called.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/servlet/jsp/tagext/TagAdapter.html#doEndTag--">doEndTag</a></span>()</code>
<div class="block">Must not be called.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/servlet/jsp/tagext/TagAdapter.html#doStartTag--">doStartTag</a></span>()</code>
<div class="block">Must not be called.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../jakarta/servlet/jsp/tagext/JspTag.html" title="interface in jakarta.servlet.jsp.tagext">JspTag</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/servlet/jsp/tagext/TagAdapter.html#getAdaptee--">getAdaptee</a></span>()</code>
<div class="block">Gets the tag that is being adapted to the Tag interface.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html" title="interface in jakarta.servlet.jsp.tagext">Tag</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/servlet/jsp/tagext/TagAdapter.html#getParent--">getParent</a></span>()</code>
<div class="block">Returns the parent of this tag, which is always getAdaptee().getParent().</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/servlet/jsp/tagext/TagAdapter.html#release--">release</a></span>()</code>
<div class="block">Must not be called.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/servlet/jsp/tagext/TagAdapter.html#setPageContext-jakarta.servlet.jsp.PageContext-">setPageContext</a></span>(<a href="../../../../jakarta/servlet/jsp/PageContext.html" title="class in jakarta.servlet.jsp">PageContext</a>&nbsp;pc)</code>
<div class="block">Must not be called.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/servlet/jsp/tagext/TagAdapter.html#setParent-jakarta.servlet.jsp.tagext.Tag-">setParent</a></span>(<a href="../../../../jakarta/servlet/jsp/tagext/Tag.html" title="interface in jakarta.servlet.jsp.tagext">Tag</a>&nbsp;parentTag)</code>
<div class="block">Must not be called.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TagAdapter-jakarta.servlet.jsp.tagext.SimpleTag-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TagAdapter</h4>
<pre>public&nbsp;TagAdapter(<a href="../../../../jakarta/servlet/jsp/tagext/SimpleTag.html" title="interface in jakarta.servlet.jsp.tagext">SimpleTag</a>&nbsp;adaptee)</pre>
<div class="block">Creates a new TagAdapter that wraps the given SimpleTag and returns the parent tag when getParent() is called.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>adaptee</code> - The SimpleTag being adapted as a Tag.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setPageContext-jakarta.servlet.jsp.PageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPageContext</h4>
<pre>public&nbsp;void&nbsp;setPageContext(<a href="../../../../jakarta/servlet/jsp/PageContext.html" title="class in jakarta.servlet.jsp">PageContext</a>&nbsp;pc)</pre>
<div class="block">Must not be called.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html#setPageContext-jakarta.servlet.jsp.PageContext-">setPageContext</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html" title="interface in jakarta.servlet.jsp.tagext">Tag</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pc</code> - ignored.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - Must not be called</dd>
</dl>
</li>
</ul>
<a name="setParent-jakarta.servlet.jsp.tagext.Tag-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParent</h4>
<pre>public&nbsp;void&nbsp;setParent(<a href="../../../../jakarta/servlet/jsp/tagext/Tag.html" title="interface in jakarta.servlet.jsp.tagext">Tag</a>&nbsp;parentTag)</pre>
<div class="block">Must not be called. The parent of this tag is always getAdaptee().getParent().</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html#setParent-jakarta.servlet.jsp.tagext.Tag-">setParent</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html" title="interface in jakarta.servlet.jsp.tagext">Tag</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parentTag</code> - ignored.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - Must not be called.</dd>
</dl>
</li>
</ul>
<a name="getParent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
<pre>public&nbsp;<a href="../../../../jakarta/servlet/jsp/tagext/Tag.html" title="interface in jakarta.servlet.jsp.tagext">Tag</a>&nbsp;getParent()</pre>
<div class="block">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).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html#getParent--">getParent</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html" title="interface in jakarta.servlet.jsp.tagext">Tag</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The parent of the tag being adapted.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../jakarta/servlet/jsp/tagext/TagSupport.html#findAncestorWithClass-jakarta.servlet.jsp.tagext.Tag-java.lang.Class-"><code>TagSupport.findAncestorWithClass(jakarta.servlet.jsp.tagext.Tag, java.lang.Class&lt;?&gt;)</code></a></dd>
</dl>
</li>
</ul>
<a name="getAdaptee--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAdaptee</h4>
<pre>public&nbsp;<a href="../../../../jakarta/servlet/jsp/tagext/JspTag.html" title="interface in jakarta.servlet.jsp.tagext">JspTag</a>&nbsp;getAdaptee()</pre>
<div class="block">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.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the tag that is being adapted</dd>
</dl>
</li>
</ul>
<a name="doStartTag--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doStartTag</h4>
<pre>public&nbsp;int&nbsp;doStartTag()
throws <a href="../../../../jakarta/servlet/jsp/JspException.html" title="class in jakarta.servlet.jsp">JspException</a></pre>
<div class="block">Must not be called.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html#doStartTag--">doStartTag</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html" title="interface in jakarta.servlet.jsp.tagext">Tag</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>always throws UnsupportedOperationException</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - Must not be called</dd>
<dd><code><a href="../../../../jakarta/servlet/jsp/JspException.html" title="class in jakarta.servlet.jsp">JspException</a></code> - never thrown</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../jakarta/servlet/jsp/tagext/BodyTag.html" title="interface in jakarta.servlet.jsp.tagext"><code>BodyTag</code></a></dd>
</dl>
</li>
</ul>
<a name="doEndTag--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doEndTag</h4>
<pre>public&nbsp;int&nbsp;doEndTag()
throws <a href="../../../../jakarta/servlet/jsp/JspException.html" title="class in jakarta.servlet.jsp">JspException</a></pre>
<div class="block">Must not be called.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html#doEndTag--">doEndTag</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html" title="interface in jakarta.servlet.jsp.tagext">Tag</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>always throws UnsupportedOperationException</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - Must not be called</dd>
<dd><code><a href="../../../../jakarta/servlet/jsp/JspException.html" title="class in jakarta.servlet.jsp">JspException</a></code> - never thrown</dd>
</dl>
</li>
</ul>
<a name="release--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>release</h4>
<pre>public&nbsp;void&nbsp;release()</pre>
<div class="block">Must not be called.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html#release--">release</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html" title="interface in jakarta.servlet.jsp.tagext">Tag</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - Must not be called</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../jakarta/servlet/jsp/tagext/Tag.html" title="interface in jakarta.servlet.jsp.tagext"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../jakarta/servlet/jsp/tagext/TagAttributeInfo.html" title="class in jakarta.servlet.jsp.tagext"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jakarta/servlet/jsp/tagext/TagAdapter.html" target="_top">Frames</a></li>
<li><a href="TagAdapter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>