/usr/share/doc/libservlet3.0-java/api/javax/servlet/jsp/JspWriter.html is in libservlet3.0-java-doc 7.0.56-3+deb8u11.
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 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.7.0_131) on Tue Jun 20 18:23:53 UTC 2017 -->
<title>JspWriter (Tomcat API Documentation)</title>
<meta name="date" content="2017-06-20">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JspWriter (Tomcat API Documentation)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="../../../javax/servlet/jsp/JspTagException.html" title="class in javax.servlet.jsp"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../javax/servlet/jsp/PageContext.html" title="class in javax.servlet.jsp"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/servlet/jsp/JspWriter.html" target="_top">Frames</a></li>
<li><a href="JspWriter.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="#field_summary">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><a href="#field_detail">Field</a> | </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</div>
<h2 title="Class JspWriter" class="title">Class JspWriter</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>javax.servlet.jsp.JspWriter</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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../javax/servlet/jsp/tagext/BodyContent.html" title="class in javax.servlet.jsp.tagext">BodyContent</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">JspWriter</span>
extends java.io.Writer</pre>
<div class="block"><p>
The actions and template data in a JSP page is written using the JspWriter
object that is referenced by the implicit variable out which is initialized
automatically using methods in the PageContext object.
<p>
This abstract class emulates some of the functionality found in the
java.io.BufferedWriter and java.io.PrintWriter classes, however it differs in
that it throws java.io.IOException from the print methods while PrintWriter
does not.
<p>
<B>Buffering</B>
<p>
The initial JspWriter object is associated with the PrintWriter object of the
ServletResponse in a way that depends on whether the page is or is not
buffered. If the page is not buffered, output written to this JspWriter
object will be written through to the PrintWriter directly, which will be
created if necessary by invoking the getWriter() method on the response
object. But if the page is buffered, the PrintWriter object will not be
created until the buffer is flushed and operations like setContentType() are
legal. Since this flexibility simplifies programming substantially, buffering
is the default for JSP pages.
<p>
Buffering raises the issue of what to do when the buffer is exceeded. Two
approaches can be taken:
<ul>
<li>Exceeding the buffer is not a fatal error; when the buffer is exceeded,
just flush the output.
<li>Exceeding the buffer is a fatal error; when the buffer is exceeded, raise
an exception.
</ul>
<p>
Both approaches are valid, and thus both are supported in the JSP technology.
The behavior of a page is controlled by the autoFlush attribute, which
defaults to true. In general, JSP pages that need to be sure that correct and
complete data has been sent to their client may want to set autoFlush to
false, with a typical case being that where the client is an application
itself. On the other hand, JSP pages that send data that is meaningful even
when partially constructed may want to set autoFlush to true; such as when
the data is sent for immediate display through a browser. Each application
will need to consider their specific needs.
<p>
An alternative considered was to make the buffer size unbounded; but, this
had the disadvantage that runaway computations would consume an unbounded
amount of resources.
<p>
The "out" implicit variable of a JSP implementation class is of this type. If
the page directive selects autoflush="true" then all the I/O operations on
this class shall automatically flush the contents of the buffer if an
overflow condition would result if the current operation were performed
without a flush. If autoflush="false" then all the I/O operations on this
class shall throw an IOException if performing the current operation would
result in a buffer overflow condition.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><code>Writer</code>,
<code>BufferedWriter</code>,
<code>PrintWriter</code></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>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#autoFlush">autoFlush</a></strong></code>
<div class="block">Whether the JspWriter is autoflushing.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#bufferSize">bufferSize</a></strong></code>
<div class="block">The size of the buffer used by the JspWriter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#DEFAULT_BUFFER">DEFAULT_BUFFER</a></strong></code>
<div class="block">Constant indicating that the Writer is buffered and is using the
implementation default buffer size.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#NO_BUFFER">NO_BUFFER</a></strong></code>
<div class="block">Constant indicating that the Writer is not buffering output.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#UNBOUNDED_BUFFER">UNBOUNDED_BUFFER</a></strong></code>
<div class="block">Constant indicating that the Writer is buffered and is unbounded; this is
used in BodyContent.</div>
</td>
</tr>
</table>
<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="overviewSummary" 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><strong><a href="../../../javax/servlet/jsp/JspWriter.html#JspWriter(int,%20boolean)">JspWriter</a></strong>(int bufferSize,
boolean autoFlush)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#clear()">clear</a></strong>()</code>
<div class="block">Clear the contents of the buffer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#clearBuffer()">clearBuffer</a></strong>()</code>
<div class="block">Clears the current contents of the buffer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#close()">close</a></strong>()</code>
<div class="block">Close the stream, flushing it first.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#flush()">flush</a></strong>()</code>
<div class="block">Flush the stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#getBufferSize()">getBufferSize</a></strong>()</code>
<div class="block">This method returns the size of the buffer used by the JspWriter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#getRemaining()">getRemaining</a></strong>()</code>
<div class="block">This method returns the number of unused bytes in the buffer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#isAutoFlush()">isAutoFlush</a></strong>()</code>
<div class="block">This method indicates whether the JspWriter is autoFlushing.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#newLine()">newLine</a></strong>()</code>
<div class="block">Write a line separator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#print(boolean)">print</a></strong>(boolean b)</code>
<div class="block">Print a boolean value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#print(char)">print</a></strong>(char c)</code>
<div class="block">Print a character.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#print(char[])">print</a></strong>(char[] s)</code>
<div class="block">Print an array of characters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#print(double)">print</a></strong>(double d)</code>
<div class="block">Print a double-precision floating-point number.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#print(float)">print</a></strong>(float f)</code>
<div class="block">Print a floating-point number.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#print(int)">print</a></strong>(int i)</code>
<div class="block">Print an integer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#print(long)">print</a></strong>(long l)</code>
<div class="block">Print a long integer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#print(java.lang.Object)">print</a></strong>(java.lang.Object obj)</code>
<div class="block">Print an object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#print(java.lang.String)">print</a></strong>(java.lang.String s)</code>
<div class="block">Print a string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#println()">println</a></strong>()</code>
<div class="block">Terminate the current line by writing the line separator string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#println(boolean)">println</a></strong>(boolean x)</code>
<div class="block">Print a boolean value and then terminate the line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#println(char)">println</a></strong>(char x)</code>
<div class="block">Print a character and then terminate the line.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#println(char[])">println</a></strong>(char[] x)</code>
<div class="block">Print an array of characters and then terminate the line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#println(double)">println</a></strong>(double x)</code>
<div class="block">Print a double-precision floating-point number and then terminate the
line.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#println(float)">println</a></strong>(float x)</code>
<div class="block">Print a floating-point number and then terminate the line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#println(int)">println</a></strong>(int x)</code>
<div class="block">Print an integer and then terminate the line.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#println(long)">println</a></strong>(long x)</code>
<div class="block">Print a long integer and then terminate the line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#println(java.lang.Object)">println</a></strong>(java.lang.Object x)</code>
<div class="block">Print an Object and then terminate the line.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/jsp/JspWriter.html#println(java.lang.String)">println</a></strong>(java.lang.String x)</code>
<div class="block">Print a String and then terminate the line.</div>
</td>
</tr>
</table>
<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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="NO_BUFFER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NO_BUFFER</h4>
<pre>public static final int NO_BUFFER</pre>
<div class="block">Constant indicating that the Writer is not buffering output.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#javax.servlet.jsp.JspWriter.NO_BUFFER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DEFAULT_BUFFER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_BUFFER</h4>
<pre>public static final int DEFAULT_BUFFER</pre>
<div class="block">Constant indicating that the Writer is buffered and is using the
implementation default buffer size.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#javax.servlet.jsp.JspWriter.DEFAULT_BUFFER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="UNBOUNDED_BUFFER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNBOUNDED_BUFFER</h4>
<pre>public static final int UNBOUNDED_BUFFER</pre>
<div class="block">Constant indicating that the Writer is buffered and is unbounded; this is
used in BodyContent.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#javax.servlet.jsp.JspWriter.UNBOUNDED_BUFFER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="bufferSize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bufferSize</h4>
<pre>protected int bufferSize</pre>
<div class="block">The size of the buffer used by the JspWriter.</div>
</li>
</ul>
<a name="autoFlush">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>autoFlush</h4>
<pre>protected boolean autoFlush</pre>
<div class="block">Whether the JspWriter is autoflushing.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JspWriter(int, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JspWriter</h4>
<pre>protected JspWriter(int bufferSize,
boolean autoFlush)</pre>
<div class="block">Protected constructor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bufferSize</code> - the size of the buffer to be used by the JspWriter</dd><dd><code>autoFlush</code> - whether the JspWriter should be autoflushing</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="newLine()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newLine</h4>
<pre>public abstract void newLine()
throws java.io.IOException</pre>
<div class="block">Write a line separator. The line separator string is defined by the
system property <tt>line.separator</tt>, and is not necessarily a single
newline ('\n') character.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an I/O error occurs</dd></dl>
</li>
</ul>
<a name="print(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
<pre>public abstract void print(boolean b)
throws java.io.IOException</pre>
<div class="block">Print a boolean value. The string produced by <code><code>String.valueOf(boolean)</code></code>
is written to the JspWriter's buffer or, if no buffer is used, directly
to the underlying writer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - The <code>boolean</code> to be printed</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd></dl>
</li>
</ul>
<a name="print(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
<pre>public abstract void print(char c)
throws java.io.IOException</pre>
<div class="block">Print a character. The character is written to the JspWriter's buffer or,
if no buffer is used, directly to the underlying writer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - The <code>char</code> to be printed</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd></dl>
</li>
</ul>
<a name="print(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
<pre>public abstract void print(int i)
throws java.io.IOException</pre>
<div class="block">Print an integer. The string produced by <code><code>String.valueOf(int)</code></code>
is written to the JspWriter's buffer or, if no buffer is used, directly
to the underlying writer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - The <code>int</code> to be printed</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd><dt><span class="strong">See Also:</span></dt><dd><code>Integer.toString(int)</code></dd></dl>
</li>
</ul>
<a name="print(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
<pre>public abstract void print(long l)
throws java.io.IOException</pre>
<div class="block">Print a long integer. The string produced by <code><code>String.valueOf(long)</code></code>
is written to the JspWriter's buffer or, if no buffer is used, directly
to the underlying writer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>l</code> - The <code>long</code> to be printed</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd><dt><span class="strong">See Also:</span></dt><dd><code>Long.toString(long)</code></dd></dl>
</li>
</ul>
<a name="print(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
<pre>public abstract void print(float f)
throws java.io.IOException</pre>
<div class="block">Print a floating-point number. The string produced by <code><code>String.valueOf(float)</code></code>
is written to the JspWriter's buffer or, if no buffer is used, directly
to the underlying writer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>f</code> - The <code>float</code> to be printed</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd><dt><span class="strong">See Also:</span></dt><dd><code>Float.toString(float)</code></dd></dl>
</li>
</ul>
<a name="print(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
<pre>public abstract void print(double d)
throws java.io.IOException</pre>
<div class="block">Print a double-precision floating-point number. The string produced by
<code><code>String.valueOf(double)</code></code> is written to the
JspWriter's buffer or, if no buffer is used, directly to the underlying
writer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>d</code> - The <code>double</code> to be printed</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd><dt><span class="strong">See Also:</span></dt><dd><code>Double.toString(double)</code></dd></dl>
</li>
</ul>
<a name="print(char[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
<pre>public abstract void print(char[] s)
throws java.io.IOException</pre>
<div class="block">Print an array of characters. The characters are written to the
JspWriter's buffer or, if no buffer is used, directly to the underlying
writer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>s</code> - The array of chars to be printed</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - If <code>s</code> is <code>null</code></dd>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd></dl>
</li>
</ul>
<a name="print(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
<pre>public abstract void print(java.lang.String s)
throws java.io.IOException</pre>
<div class="block">Print a string. If the argument is <code>null</code> then the string
<code>"null"</code> is printed. Otherwise, the string's characters are
written to the JspWriter's buffer or, if no buffer is used, directly to
the underlying writer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>s</code> - The <code>String</code> to be printed</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd></dl>
</li>
</ul>
<a name="print(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
<pre>public abstract void print(java.lang.Object obj)
throws java.io.IOException</pre>
<div class="block">Print an object. The string produced by the <code><code>String.valueOf(Object)</code></code>
method is written to the JspWriter's buffer or, if no buffer is used,
directly to the underlying writer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - The <code>Object</code> to be printed</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd><dt><span class="strong">See Also:</span></dt><dd><code>Object.toString()</code></dd></dl>
</li>
</ul>
<a name="println()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>println</h4>
<pre>public abstract void println()
throws java.io.IOException</pre>
<div class="block">Terminate the current line by writing the line separator string. The line
separator string is defined by the system property
<code>line.separator</code>, and is not necessarily a single newline
character (<code>'\n'</code>).</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd></dl>
</li>
</ul>
<a name="println(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>println</h4>
<pre>public abstract void println(boolean x)
throws java.io.IOException</pre>
<div class="block">Print a boolean value and then terminate the line. This method behaves as
though it invokes <code><a href="../../../javax/servlet/jsp/JspWriter.html#print(boolean)"><code>print(boolean)</code></a></code> and then
<code><a href="../../../javax/servlet/jsp/JspWriter.html#println()"><code>println()</code></a></code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the boolean to write</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd></dl>
</li>
</ul>
<a name="println(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>println</h4>
<pre>public abstract void println(char x)
throws java.io.IOException</pre>
<div class="block">Print a character and then terminate the line. This method behaves as
though it invokes <code><a href="../../../javax/servlet/jsp/JspWriter.html#print(char)"><code>print(char)</code></a></code> and then <code><a href="../../../javax/servlet/jsp/JspWriter.html#println()"><code>println()</code></a></code>
.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the char to write</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd></dl>
</li>
</ul>
<a name="println(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>println</h4>
<pre>public abstract void println(int x)
throws java.io.IOException</pre>
<div class="block">Print an integer and then terminate the line. This method behaves as
though it invokes <code><a href="../../../javax/servlet/jsp/JspWriter.html#print(int)"><code>print(int)</code></a></code> and then <code><a href="../../../javax/servlet/jsp/JspWriter.html#println()"><code>println()</code></a></code>
.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the int to write</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd></dl>
</li>
</ul>
<a name="println(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>println</h4>
<pre>public abstract void println(long x)
throws java.io.IOException</pre>
<div class="block">Print a long integer and then terminate the line. This method behaves as
though it invokes <code><a href="../../../javax/servlet/jsp/JspWriter.html#print(long)"><code>print(long)</code></a></code> and then
<code><a href="../../../javax/servlet/jsp/JspWriter.html#println()"><code>println()</code></a></code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the long to write</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd></dl>
</li>
</ul>
<a name="println(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>println</h4>
<pre>public abstract void println(float x)
throws java.io.IOException</pre>
<div class="block">Print a floating-point number and then terminate the line. This method
behaves as though it invokes <code><a href="../../../javax/servlet/jsp/JspWriter.html#print(float)"><code>print(float)</code></a></code> and then
<code><a href="../../../javax/servlet/jsp/JspWriter.html#println()"><code>println()</code></a></code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the float to write</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd></dl>
</li>
</ul>
<a name="println(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>println</h4>
<pre>public abstract void println(double x)
throws java.io.IOException</pre>
<div class="block">Print a double-precision floating-point number and then terminate the
line. This method behaves as though it invokes <code><a href="../../../javax/servlet/jsp/JspWriter.html#print(double)"><code>print(double)</code></a></code> and
then <code><a href="../../../javax/servlet/jsp/JspWriter.html#println()"><code>println()</code></a></code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the double to write</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd></dl>
</li>
</ul>
<a name="println(char[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>println</h4>
<pre>public abstract void println(char[] x)
throws java.io.IOException</pre>
<div class="block">Print an array of characters and then terminate the line. This method
behaves as though it invokes <code>print(char[])</code> and then
<code>println()</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the char[] to write</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd></dl>
</li>
</ul>
<a name="println(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>println</h4>
<pre>public abstract void println(java.lang.String x)
throws java.io.IOException</pre>
<div class="block">Print a String and then terminate the line. This method behaves as though
it invokes <code><a href="../../../javax/servlet/jsp/JspWriter.html#print(java.lang.String)"><code>print(String)</code></a></code> and then
<code><a href="../../../javax/servlet/jsp/JspWriter.html#println()"><code>println()</code></a></code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the String to write</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd></dl>
</li>
</ul>
<a name="println(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>println</h4>
<pre>public abstract void println(java.lang.Object x)
throws java.io.IOException</pre>
<div class="block">Print an Object and then terminate the line. This method behaves as
though it invokes <code><a href="../../../javax/servlet/jsp/JspWriter.html#print(java.lang.Object)"><code>print(Object)</code></a></code> and then
<code><a href="../../../javax/servlet/jsp/JspWriter.html#println()"><code>println()</code></a></code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the Object to write</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an error occurred while writing</dd></dl>
</li>
</ul>
<a name="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public abstract void clear()
throws java.io.IOException</pre>
<div class="block">Clear the contents of the buffer. If the buffer has been already been
flushed then the clear operation shall throw an IOException to signal the
fact that some data has already been irrevocably written to the client
response stream.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an I/O error occurs</dd></dl>
</li>
</ul>
<a name="clearBuffer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearBuffer</h4>
<pre>public abstract void clearBuffer()
throws java.io.IOException</pre>
<div class="block">Clears the current contents of the buffer. Unlike clear(), this method
will not throw an IOException if the buffer has already been flushed. It
merely clears the current content of the buffer and returns.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an I/O error occurs</dd></dl>
</li>
</ul>
<a name="flush()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flush</h4>
<pre>public abstract void flush()
throws java.io.IOException</pre>
<div class="block">Flush the stream. If the stream has saved any characters from the various
write() methods in a buffer, write them immediately to their intended
destination. Then, if that destination is another character or byte
stream, flush it. Thus one flush() invocation will flush all the buffers
in a chain of Writers and OutputStreams.
<p>
The method may be invoked indirectly if the buffer size is exceeded.
<p>
Once a stream has been closed, further write() or flush() invocations
will cause an IOException to be thrown.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>flush</code> in interface <code>java.io.Flushable</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>flush</code> in class <code>java.io.Writer</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an I/O error occurs</dd></dl>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public abstract void close()
throws java.io.IOException</pre>
<div class="block">Close the stream, flushing it first.
<p>
This method needs not be invoked explicitly for the initial JspWriter as
the code generated by the JSP container will automatically include a call
to close().
<p>
Closing a previously-closed stream, unlike flush(), has no effect.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>close</code> in interface <code>java.io.Closeable</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>close</code> in class <code>java.io.Writer</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an I/O error occurs</dd></dl>
</li>
</ul>
<a name="getBufferSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBufferSize</h4>
<pre>public int getBufferSize()</pre>
<div class="block">This method returns the size of the buffer used by the JspWriter.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the size of the buffer in bytes, or 0 is unbuffered.</dd></dl>
</li>
</ul>
<a name="getRemaining()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemaining</h4>
<pre>public abstract int getRemaining()</pre>
<div class="block">This method returns the number of unused bytes in the buffer.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of bytes unused in the buffer</dd></dl>
</li>
</ul>
<a name="isAutoFlush()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isAutoFlush</h4>
<pre>public boolean isAutoFlush()</pre>
<div class="block">This method indicates whether the JspWriter is autoFlushing.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>if this JspWriter is auto flushing or throwing IOExceptions on
buffer overflow conditions</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="../../../javax/servlet/jsp/JspTagException.html" title="class in javax.servlet.jsp"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../javax/servlet/jsp/PageContext.html" title="class in javax.servlet.jsp"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/servlet/jsp/JspWriter.html" target="_top">Frames</a></li>
<li><a href="JspWriter.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="#field_summary">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><a href="#field_detail">Field</a> | </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-2013 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>
|