/usr/share/doc/libservlet3.0-java/api/javax/servlet/jsp/tagext/BodyContent.html is in libservlet3.0-java-doc 7.0.75-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<title>BodyContent (Tomcat API Documentation)</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="BodyContent (Tomcat API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>Prev Class</li>
<li><a href="../../../../javax/servlet/jsp/tagext/BodyTag.html" title="interface in javax.servlet.jsp.tagext"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/servlet/jsp/tagext/BodyContent.html" target="_top">Frames</a></li>
<li><a href="BodyContent.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All 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: </li>
<li>Nested | </li>
<li><a href="#fields.inherited.from.class.javax.servlet.jsp.JspWriter">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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">javax.servlet.jsp.tagext</div>
<h2 title="Class BodyContent" class="title">Class BodyContent</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.io.Writer</li>
<li>
<ul class="inheritance">
<li><a href="../../../../javax/servlet/jsp/JspWriter.html" title="class in javax.servlet.jsp">javax.servlet.jsp.JspWriter</a></li>
<li>
<ul class="inheritance">
<li>javax.servlet.jsp.tagext.BodyContent</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable</dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">BodyContent</span>
extends <a href="../../../../javax/servlet/jsp/JspWriter.html" title="class in javax.servlet.jsp">JspWriter</a></pre>
<div class="block">An encapsulation of the evaluation of the body of an action so it is
available to a tag handler. BodyContent is a subclass of JspWriter.
<p>
Note that the content of BodyContent is the result of evaluation, so it will
not contain actions and the like, but the result of their invocation.
<p>
BodyContent has methods to convert its contents into a String, to read its
contents, and to clear the contents.
<p>
The buffer size of a BodyContent object is unbounded. A BodyContent object
cannot be in autoFlush mode. It is not possible to invoke flush on a
BodyContent object, as there is no backing stream.
<p>
Instances of BodyContent are created by invoking the pushBody and popBody
methods of the PageContext class. A BodyContent is enclosed within another
JspWriter (maybe another BodyContent object) following the structure of their
associated actions.
<p>
A BodyContent is made available to a BodyTag through a setBodyContent() call.
The tag handler can use the object until after the call to doEndTag().</div>
</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.javax.servlet.jsp.JspWriter">
<!-- -->
</a>
<h3>Fields inherited from class javax.servlet.jsp.<a href="../../../../javax/servlet/jsp/JspWriter.html" title="class in javax.servlet.jsp">JspWriter</a></h3>
<code><a href="../../../../javax/servlet/jsp/JspWriter.html#autoFlush">autoFlush</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#bufferSize">bufferSize</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#DEFAULT_BUFFER">DEFAULT_BUFFER</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#NO_BUFFER">NO_BUFFER</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#UNBOUNDED_BUFFER">UNBOUNDED_BUFFER</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.java.io.Writer">
<!-- -->
</a>
<h3>Fields inherited from class java.io.Writer</h3>
<code>lock</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"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/BodyContent.html#BodyContent-javax.servlet.jsp.JspWriter-">BodyContent</a></span>(<a href="../../../../javax/servlet/jsp/JspWriter.html" title="class in javax.servlet.jsp">JspWriter</a> e)</code>
<div class="block">Protected constructor.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/BodyContent.html#clearBody--">clearBody</a></span>()</code>
<div class="block">Clear the body without throwing any exceptions.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/BodyContent.html#flush--">flush</a></span>()</code>
<div class="block">Redefined flush() so it is not legal.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../javax/servlet/jsp/JspWriter.html" title="class in javax.servlet.jsp">JspWriter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/BodyContent.html#getEnclosingWriter--">getEnclosingWriter</a></span>()</code>
<div class="block">Get the enclosing JspWriter.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract java.io.Reader</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/BodyContent.html#getReader--">getReader</a></span>()</code>
<div class="block">Return the value of this BodyContent as a Reader.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/BodyContent.html#getString--">getString</a></span>()</code>
<div class="block">Return the value of the BodyContent as a String.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/BodyContent.html#writeOut-java.io.Writer-">writeOut</a></span>(java.io.Writer out)</code>
<div class="block">Write the contents of this BodyContent into a Writer.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.servlet.jsp.JspWriter">
<!-- -->
</a>
<h3>Methods inherited from class javax.servlet.jsp.<a href="../../../../javax/servlet/jsp/JspWriter.html" title="class in javax.servlet.jsp">JspWriter</a></h3>
<code><a href="../../../../javax/servlet/jsp/JspWriter.html#clear--">clear</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#clearBuffer--">clearBuffer</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#close--">close</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#getBufferSize--">getBufferSize</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#getRemaining--">getRemaining</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#isAutoFlush--">isAutoFlush</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#newLine--">newLine</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#print-boolean-">print</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#print-char-">print</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#print-char:A-">print</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#print-double-">print</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#print-float-">print</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#print-int-">print</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#print-long-">print</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#print-java.lang.Object-">print</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#print-java.lang.String-">print</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#println--">println</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#println-boolean-">println</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#println-char-">println</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#println-char:A-">println</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#println-double-">println</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#println-float-">println</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#println-int-">println</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#println-long-">println</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#println-java.lang.Object-">println</a>, <a href="../../../../javax/servlet/jsp/JspWriter.html#println-java.lang.String-">println</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.io.Writer">
<!-- -->
</a>
<h3>Methods inherited from class java.io.Writer</h3>
<code>append, append, append, write, write, write, write, write</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class 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="BodyContent-javax.servlet.jsp.JspWriter-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BodyContent</h4>
<pre>protected BodyContent(<a href="../../../../javax/servlet/jsp/JspWriter.html" title="class in javax.servlet.jsp">JspWriter</a> e)</pre>
<div class="block">Protected constructor. Unbounded buffer, no autoflushing.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>e</code> - the enclosing JspWriter</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="flush--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flush</h4>
<pre>public void flush()
throws java.io.IOException</pre>
<div class="block">Redefined flush() so it is not legal.
<p>
It is not valid to flush a BodyContent because there is no backing stream
behind it.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>flush</code> in interface <code>java.io.Flushable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../javax/servlet/jsp/JspWriter.html#flush--">flush</a></code> in class <code><a href="../../../../javax/servlet/jsp/JspWriter.html" title="class in javax.servlet.jsp">JspWriter</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - always thrown</dd>
</dl>
</li>
</ul>
<a name="clearBody--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearBody</h4>
<pre>public void clearBody()</pre>
<div class="block">Clear the body without throwing any exceptions.</div>
</li>
</ul>
<a name="getReader--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReader</h4>
<pre>public abstract java.io.Reader getReader()</pre>
<div class="block">Return the value of this BodyContent as a Reader.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of this BodyContent as a Reader</dd>
</dl>
</li>
</ul>
<a name="getString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getString</h4>
<pre>public abstract java.lang.String getString()</pre>
<div class="block">Return the value of the BodyContent as a String.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the BodyContent as a String</dd>
</dl>
</li>
</ul>
<a name="writeOut-java.io.Writer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeOut</h4>
<pre>public abstract void writeOut(java.io.Writer out)
throws java.io.IOException</pre>
<div class="block">Write the contents of this BodyContent into a Writer. Subclasses may
optimize common invocation patterns.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - The writer into which to place the contents of this body
evaluation</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurred while writing the contents of this
BodyContent to the given Writer</dd>
</dl>
</li>
</ul>
<a name="getEnclosingWriter--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getEnclosingWriter</h4>
<pre>public <a href="../../../../javax/servlet/jsp/JspWriter.html" title="class in javax.servlet.jsp">JspWriter</a> getEnclosingWriter()</pre>
<div class="block">Get the enclosing JspWriter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enclosing JspWriter passed at construction time</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>Prev Class</li>
<li><a href="../../../../javax/servlet/jsp/tagext/BodyTag.html" title="interface in javax.servlet.jsp.tagext"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/servlet/jsp/tagext/BodyContent.html" target="_top">Frames</a></li>
<li><a href="BodyContent.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All 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: </li>
<li>Nested | </li>
<li><a href="#fields.inherited.from.class.javax.servlet.jsp.JspWriter">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2000-2016 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>
|