Package org.apache.jasper.runtime
Class BodyContentImpl
- java.lang.Object
-
- java.io.Writer
-
- javax.servlet.jsp.JspWriter
-
- javax.servlet.jsp.tagext.BodyContent
-
- org.apache.jasper.runtime.BodyContentImpl
-
- All Implemented Interfaces:
Closeable,Flushable,Appendable,AutoCloseable
public class BodyContentImpl extends BodyContent
Write text to a character-output stream, buffering characters so as to provide for the efficient writing of single characters, arrays, and strings. Provide support for discarding for the output that has been buffered.- Author:
- Rajiv Mordani, Jan Luehe
-
-
Field Summary
-
Fields inherited from class javax.servlet.jsp.JspWriter
autoFlush, bufferSize, DEFAULT_BUFFER, NO_BUFFER, UNBOUNDED_BUFFER
-
-
Constructor Summary
Constructors Constructor Description BodyContentImpl(JspWriter enclosingWriter)Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclear()Clear the contents of the buffer.voidclearBuffer()Clears the current contents of the buffer.voidclose()Close the stream, flushing it first.intgetBufferSize()This method returns the size of the buffer used by the JspWriter.ReadergetReader()Return the value of this BodyJspWriter as a Reader.intgetRemaining()This method returns the number of unused bytes in the buffer.StringgetString()Return the value of the BodyJspWriter as a String.voidnewLine()Write a line separator.voidprint(boolean b)Print a boolean value.voidprint(char c)Print a character.voidprint(char[] s)Print an array of characters.voidprint(double d)Print a double-precision floating-point number.voidprint(float f)Print a floating-point number.voidprint(int i)Print an integer.voidprint(long l)Print a long integer.voidprint(Object obj)Print an object.voidprint(String s)Print a string.voidprintln()Terminate the current line by writing the line separator string.voidprintln(boolean x)Print a boolean value and then terminate the line.voidprintln(char x)Print a character and then terminate the line.voidprintln(char[] x)Print an array of characters and then terminate the line.voidprintln(double x)Print a double-precision floating-point number and then terminate the line.voidprintln(float x)Print a floating-point number and then terminate the line.voidprintln(int x)Print an integer and then terminate the line.voidprintln(long x)Print a long integer and then terminate the line.voidprintln(Object x)Print an Object and then terminate the line.voidprintln(String x)Print a String and then terminate the line.protected voidrecycle()This method shall "reset" the internal state of a BodyContentImpl, releasing all internal references, and preparing it for potential reuse by a later invocation ofPageContextImpl.pushBody(Writer).voidwrite(char[] buf)Write an array of characters.voidwrite(char[] cbuf, int off, int len)Write a portion of an array of characters.voidwrite(int c)Write a single character.voidwrite(String s)Write a string.voidwrite(String s, int off, int len)Write a portion of a String.voidwriteOut(Writer out)Write the contents of this BodyJspWriter into a Writer.-
Methods inherited from class javax.servlet.jsp.tagext.BodyContent
clearBody, flush, getEnclosingWriter
-
Methods inherited from class javax.servlet.jsp.JspWriter
isAutoFlush
-
Methods inherited from class java.io.Writer
append, append, append, nullWriter
-
-
-
-
Constructor Detail
-
BodyContentImpl
public BodyContentImpl(JspWriter enclosingWriter)
Constructor.- Parameters:
enclosingWriter- The wrapped writer
-
-
Method Detail
-
write
public void write(int c) throws IOExceptionWrite a single character.- Overrides:
writein classWriter- Parameters:
c- The char to write- Throws:
IOException- Error writing to wrapped writer
-
write
public void write(char[] cbuf, int off, int len) throws IOExceptionWrite a portion of an array of characters.Ordinarily this method stores characters from the given array into this stream's buffer, flushing the buffer to the underlying stream as needed. If the requested length is at least as large as the buffer, however, then this method will flush the buffer and write the characters directly to the underlying stream. Thus redundant
DiscardableBufferedWriters will not copy data unnecessarily.- Specified by:
writein classWriter- Parameters:
cbuf- A character arrayoff- Offset from which to start reading characterslen- Number of characters to write- Throws:
IOException- Error writing to wrapped writer
-
write
public void write(char[] buf) throws IOExceptionWrite an array of characters. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.- Overrides:
writein classWriter- Parameters:
buf- Content to write- Throws:
IOException- Error writing to wrapped writer
-
write
public void write(String s, int off, int len) throws IOException
Write a portion of a String.- Overrides:
writein classWriter- Parameters:
s- String to be writtenoff- Offset from which to start reading characterslen- Number of characters to be written- Throws:
IOException- Error writing to wrapped writer
-
write
public void write(String s) throws IOException
Write a string. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.- Overrides:
writein classWriter- Parameters:
s- String to be written- Throws:
IOException- Error writing to wrapped writer
-
newLine
public void newLine() throws IOExceptionWrite a line separator. The line separator string is defined by the system propertyline.separator, and is not necessarily a single newline ('\n') character.- Specified by:
newLinein classJspWriter- Throws:
IOException- Error writing to wrapped writer
-
print
public void print(boolean b) throws IOExceptionPrint a boolean value. The string produced byis translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(boolean)method.write(int)- Specified by:
printin classJspWriter- Parameters:
b- Thebooleanto be printed- Throws:
IOException- Error writing to wrapped writer
-
print
public void print(char c) throws IOExceptionPrint a character. The character is translated into one or more bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of themethod.write(int)- Specified by:
printin classJspWriter- Parameters:
c- Thecharto be printed- Throws:
IOException- Error writing to wrapped writer
-
print
public void print(int i) throws IOExceptionPrint an integer. The string produced byis translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(int)method.write(int)- Specified by:
printin classJspWriter- Parameters:
i- Theintto be printed- Throws:
IOException- Error writing to wrapped writer- See Also:
Integer.toString(int)
-
print
public void print(long l) throws IOExceptionPrint a long integer. The string produced byis translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(long)method.write(int)- Specified by:
printin classJspWriter- Parameters:
l- Thelongto be printed- Throws:
IOException- Error writing to wrapped writer- See Also:
Long.toString(long)
-
print
public void print(float f) throws IOExceptionPrint a floating-point number. The string produced byis translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(float)method.write(int)- Specified by:
printin classJspWriter- Parameters:
f- Thefloatto be printed- Throws:
IOException- Error writing to wrapped writer- See Also:
Float.toString(float)
-
print
public void print(double d) throws IOExceptionPrint a double-precision floating-point number. The string produced byis translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(double)method.write(int)- Specified by:
printin classJspWriter- Parameters:
d- Thedoubleto be printed- Throws:
IOException- Error writing to wrapped writer- See Also:
Double.toString(double)
-
print
public void print(char[] s) throws IOExceptionPrint an array of characters. The characters are converted into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of themethod.write(int)- Specified by:
printin classJspWriter- Parameters:
s- The array of chars to be printed- Throws:
NullPointerException- IfsisnullIOException- Error writing to wrapped writer
-
print
public void print(String s) throws IOException
Print a string. If the argument isnullthen the string"null"is printed. Otherwise, the string's characters are converted into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of themethod.write(int)- Specified by:
printin classJspWriter- Parameters:
s- TheStringto be printed- Throws:
IOException- Error writing to wrapped writer
-
print
public void print(Object obj) throws IOException
Print an object. The string produced by themethod is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(Object)method.write(int)- Specified by:
printin classJspWriter- Parameters:
obj- TheObjectto be printed- Throws:
IOException- Error writing to wrapped writer- See Also:
Object.toString()
-
println
public void println() throws IOExceptionTerminate the current line by writing the line separator string. The line separator string is defined by the system propertyline.separator, and is not necessarily a single newline character ('\n').- Specified by:
printlnin classJspWriter- Throws:
IOException- Error writing to wrapped writer
-
println
public void println(boolean x) throws IOExceptionPrint a boolean value and then terminate the line. This method behaves as though it invokesand thenprint(boolean).println()- Specified by:
printlnin classJspWriter- Parameters:
x- Thebooleanto be printed- Throws:
IOException- Error writing to wrapped writer
-
println
public void println(char x) throws IOExceptionPrint a character and then terminate the line. This method behaves as though it invokesand thenprint(char).println()- Specified by:
printlnin classJspWriter- Parameters:
x- Thecharto be printed- Throws:
IOException- Error writing to wrapped writer
-
println
public void println(int x) throws IOExceptionPrint an integer and then terminate the line. This method behaves as though it invokesand thenprint(int).println()- Specified by:
printlnin classJspWriter- Parameters:
x- Theintto be printed- Throws:
IOException- Error writing to wrapped writer
-
println
public void println(long x) throws IOExceptionPrint a long integer and then terminate the line. This method behaves as though it invokesand thenprint(long).println()- Specified by:
printlnin classJspWriter- Parameters:
x- Thelongto be printed- Throws:
IOException- Error writing to wrapped writer
-
println
public void println(float x) throws IOExceptionPrint a floating-point number and then terminate the line. This method behaves as though it invokesand thenprint(float).println()- Specified by:
printlnin classJspWriter- Parameters:
x- Thefloatto be printed- Throws:
IOException- Error writing to wrapped writer
-
println
public void println(double x) throws IOExceptionPrint a double-precision floating-point number and then terminate the line. This method behaves as though it invokesand thenprint(double).println()- Specified by:
printlnin classJspWriter- Parameters:
x- Thedoubleto be printed- Throws:
IOException- Error writing to wrapped writer
-
println
public void println(char[] x) throws IOExceptionPrint an array of characters and then terminate the line. This method behaves as though it invokesand thenprint(char[]).println()- Specified by:
printlnin classJspWriter- Parameters:
x- Thechararray to be printed- Throws:
IOException- Error writing to wrapped writer
-
println
public void println(String x) throws IOException
Print a String and then terminate the line. This method behaves as though it invokesand thenprint(String).println()- Specified by:
printlnin classJspWriter- Parameters:
x- The string to be printed- Throws:
IOException- Error writing to wrapped writer
-
println
public void println(Object x) throws IOException
Print an Object and then terminate the line. This method behaves as though it invokesand thenprint(Object).println()- Specified by:
printlnin classJspWriter- Parameters:
x- The object to be printed- Throws:
IOException- Error writing to wrapped writer
-
clear
public void clear() throws IOExceptionClear 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.- Specified by:
clearin classJspWriter- Throws:
IOException- If there is no wrapped writer
-
clearBuffer
public void clearBuffer() throws IOExceptionClears 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.- Specified by:
clearBufferin classJspWriter- Throws:
IOException- Should not happen
-
close
public void close() throws IOExceptionClose the stream, flushing it first. Once a stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously-closed stream, however, has no effect.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein classJspWriter- Throws:
IOException- Error writing to wrapped writer
-
getBufferSize
public int getBufferSize()
This method returns the size of the buffer used by the JspWriter.- Overrides:
getBufferSizein classJspWriter- Returns:
- the size of the buffer in bytes, or 0 is unbuffered.
-
getRemaining
public int getRemaining()
Description copied from class:javax.servlet.jsp.JspWriterThis method returns the number of unused bytes in the buffer.- Specified by:
getRemainingin classJspWriter- Returns:
- the number of bytes unused in the buffer
-
getReader
public Reader getReader()
Return the value of this BodyJspWriter as a Reader. Note: this is after evaluation!! There are no scriptlets, etc in this stream.- Specified by:
getReaderin classBodyContent- Returns:
- the value of this BodyJspWriter as a Reader
-
getString
public String getString()
Return the value of the BodyJspWriter as a String. Note: this is after evaluation!! There are no scriptlets, etc in this stream.- Specified by:
getStringin classBodyContent- Returns:
- the value of the BodyJspWriter as a String
-
writeOut
public void writeOut(Writer out) throws IOException
Write the contents of this BodyJspWriter into a Writer. Subclasses are likely to do interesting things with the implementation so some things are extra efficient.- Specified by:
writeOutin classBodyContent- Parameters:
out- The writer into which to place the contents of this body evaluation- Throws:
IOException- Error writing to writer
-
recycle
protected void recycle()
This method shall "reset" the internal state of a BodyContentImpl, releasing all internal references, and preparing it for potential reuse by a later invocation ofPageContextImpl.pushBody(Writer).Note, that BodyContentImpl instances are usually owned by a PageContextImpl instance, and PageContextImpl instances are recycled and reused.
- See Also:
PageContextImpl.release()
-
-