public abstract class BodyContent extends 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().
autoFlush, bufferSize, DEFAULT_BUFFER, NO_BUFFER, UNBOUNDED_BUFFER
Modifier | Constructor and Description |
---|---|
protected |
BodyContent(JspWriter e)
Protected constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
clearBody()
Clear the body without throwing any exceptions.
|
void |
flush()
Redefined flush() so it is not legal.
|
JspWriter |
getEnclosingWriter()
Get the enclosing JspWriter.
|
abstract Reader |
getReader()
Return the value of this BodyContent as a Reader.
|
abstract String |
getString()
Return the value of the BodyContent as a String.
|
abstract void |
writeOut(Writer out)
Write the contents of this BodyContent into a Writer.
|
clear, clearBuffer, close, getBufferSize, getRemaining, isAutoFlush, newLine, print, print, print, print, print, print, print, print, print, println, println, println, println, println, println, println, println, println, println
protected BodyContent(JspWriter e)
e
- the enclosing JspWriterpublic void flush() throws IOException
It is not valid to flush a BodyContent because there is no backing stream behind it.
flush
in interface Flushable
flush
in class JspWriter
IOException
- always thrownpublic void clearBody()
public abstract Reader getReader()
public abstract String getString()
public abstract void writeOut(Writer out) throws IOException
out
- The writer into which to place the contents of
this body evaluationIOException
- if an I/O error occurred while writing the
contents of this BodyContent to the given Writerpublic JspWriter getEnclosingWriter()
Copyright © 2017 JBoss by Red Hat. All rights reserved.