Java Doc for BodyContent.java in  » 6.0-JDK-Core » Servlet-API-by-tomcat » javax » servlet » jsp » tagext » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » Servlet API by tomcat » javax.servlet.jsp.tagext 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.io.Writer
      javax.servlet.jsp.JspWriter
         javax.servlet.jsp.tagext.BodyContent

BodyContent
abstract public class BodyContent extends JspWriter (Code)
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.

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.

BodyContent has methods to convert its contents into a String, to read its contents, and to clear the contents.

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.

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.

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().




Constructor Summary
protected  BodyContent(JspWriter e)
     Protected constructor.

Method Summary
public  voidclearBody()
     Clear the body without throwing any exceptions.
public  voidflush()
     Redefined flush() so it is not legal.
public  JspWritergetEnclosingWriter()
     Get the enclosing JspWriter.
abstract public  ReadergetReader()
     Return the value of this BodyContent as a Reader.
abstract public  StringgetString()
     Return the value of the BodyContent as a String.
abstract public  voidwriteOut(Writer out)
     Write the contents of this BodyContent into a Writer.


Constructor Detail
BodyContent
protected BodyContent(JspWriter e)(Code)
Protected constructor. Unbounded buffer, no autoflushing.
Parameters:
  e - the enclosing JspWriter




Method Detail
clearBody
public void clearBody()(Code)
Clear the body without throwing any exceptions.



flush
public void flush() throws IOException(Code)
Redefined flush() so it is not legal.

It is not valid to flush a BodyContent because there is no backing stream behind it.
throws:
  IOException - always thrown




getEnclosingWriter
public JspWriter getEnclosingWriter()(Code)
Get the enclosing JspWriter. the enclosing JspWriter passed at construction time



getReader
abstract public Reader getReader()(Code)
Return the value of this BodyContent as a Reader. the value of this BodyContent as a Reader



getString
abstract public String getString()(Code)
Return the value of the BodyContent as a String. the value of the BodyContent as a String



writeOut
abstract public void writeOut(Writer out) throws IOException(Code)
Write the contents of this BodyContent into a Writer. Subclasses may optimize common invocation patterns.
Parameters:
  out - The writer into which to place the contents ofthis body evaluation
throws:
  IOException - if an I/O error occurred while writing thecontents of this BodyContent to the given Writer



Fields inherited from javax.servlet.jsp.JspWriter
final public static int DEFAULT_BUFFER(Code)(Java Doc)
final public static int NO_BUFFER(Code)(Java Doc)
final public static int UNBOUNDED_BUFFER(Code)(Java Doc)
protected boolean autoFlush(Code)(Java Doc)
protected int bufferSize(Code)(Java Doc)

Methods inherited from javax.servlet.jsp.JspWriter
abstract public void clear() throws IOException(Code)(Java Doc)
abstract public void clearBuffer() throws IOException(Code)(Java Doc)
abstract public void close() throws IOException(Code)(Java Doc)
abstract public void flush() throws IOException(Code)(Java Doc)
public int getBufferSize()(Code)(Java Doc)
abstract public int getRemaining()(Code)(Java Doc)
public boolean isAutoFlush()(Code)(Java Doc)
abstract public void newLine() throws IOException(Code)(Java Doc)
abstract public void print(boolean b) throws IOException(Code)(Java Doc)
abstract public void print(char c) throws IOException(Code)(Java Doc)
abstract public void print(int i) throws IOException(Code)(Java Doc)
abstract public void print(long l) throws IOException(Code)(Java Doc)
abstract public void print(float f) throws IOException(Code)(Java Doc)
abstract public void print(double d) throws IOException(Code)(Java Doc)
abstract public void print(char s) throws IOException(Code)(Java Doc)
abstract public void print(String s) throws IOException(Code)(Java Doc)
abstract public void print(Object obj) throws IOException(Code)(Java Doc)
abstract public void println() throws IOException(Code)(Java Doc)
abstract public void println(boolean x) throws IOException(Code)(Java Doc)
abstract public void println(char x) throws IOException(Code)(Java Doc)
abstract public void println(int x) throws IOException(Code)(Java Doc)
abstract public void println(long x) throws IOException(Code)(Java Doc)
abstract public void println(float x) throws IOException(Code)(Java Doc)
abstract public void println(double x) throws IOException(Code)(Java Doc)
abstract public void println(char x) throws IOException(Code)(Java Doc)
abstract public void println(String x) throws IOException(Code)(Java Doc)
abstract public void println(Object x) throws IOException(Code)(Java Doc)

Fields inherited from java.io.Writer
protected Object lock(Code)(Java Doc)

Methods inherited from java.io.Writer
public Writer append(CharSequence csq) throws IOException(Code)(Java Doc)
public Writer append(CharSequence csq, int start, int end) throws IOException(Code)(Java Doc)
public Writer append(char c) throws IOException(Code)(Java Doc)
abstract public void close() throws IOException(Code)(Java Doc)
abstract public void flush() throws IOException(Code)(Java Doc)
public void write(int c) throws IOException(Code)(Java Doc)
public void write(char cbuf) throws IOException(Code)(Java Doc)
abstract public void write(char cbuf, int off, int len) throws IOException(Code)(Java Doc)
public void write(String str) throws IOException(Code)(Java Doc)
public void write(String str, int off, int len) throws IOException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.