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
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Clear the contents of the buffer.void
Clears the current contents of the buffer.void
close()
Close the stream, flushing it first.int
This method returns the size of the buffer used by the JspWriter.Return the value of this BodyJspWriter as a Reader.int
This method returns the number of unused bytes in the buffer.Return the value of the BodyJspWriter as a String.void
newLine()
Write a line separator.void
print
(boolean b) Print a boolean value.void
print
(char c) Print a character.void
print
(char[] s) Print an array of characters.void
print
(double d) Print a double-precision floating-point number.void
print
(float f) Print a floating-point number.void
print
(int i) Print an integer.void
print
(long l) Print a long integer.void
Print an object.void
Print a string.void
println()
Terminate the current line by writing the line separator string.void
println
(boolean x) Print a boolean value and then terminate the line.void
println
(char x) Print a character and then terminate the line.void
println
(char[] x) Print an array of characters and then terminate the line.void
println
(double x) Print a double-precision floating-point number and then terminate the line.void
println
(float x) Print a floating-point number and then terminate the line.void
println
(int x) Print an integer and then terminate the line.void
println
(long x) Print a long integer and then terminate the line.void
Print an Object and then terminate the line.void
Print a String and then terminate the line.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)
.void
write
(char[] buf) Write an array of characters.void
write
(char[] cbuf, int off, int len) Write a portion of an array of characters.void
write
(int c) Write a single character.void
Write a string.void
Write a portion of a String.void
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 Details
-
BodyContentImpl
Constructor.- Parameters:
enclosingWriter
- The wrapped writer
-
-
Method Details
-
write
Write a single character.- Overrides:
write
in classWriter
- Parameters:
c
- The char to write- Throws:
IOException
- Error writing to wrapped writer
-
write
Write 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
DiscardableBufferedWriter
s will not copy data unnecessarily.- Specified by:
write
in 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
Write an array of characters. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.- Overrides:
write
in classWriter
- Parameters:
buf
- Content to write- Throws:
IOException
- Error writing to wrapped writer
-
write
Write a portion of a String.- Overrides:
write
in 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
Write a string. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.- Overrides:
write
in classWriter
- Parameters:
s
- String to be written- Throws:
IOException
- Error writing to wrapped writer
-
newLine
Write 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:
newLine
in classJspWriter
- Throws:
IOException
- Error writing to wrapped writer
-
print
Print a boolean value. The string produced by
is 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:
print
in classJspWriter
- Parameters:
b
- Theboolean
to be printed- Throws:
IOException
- Error writing to wrapped writer
-
print
Print 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 the
method.write(int)
- Specified by:
print
in classJspWriter
- Parameters:
c
- Thechar
to be printed- Throws:
IOException
- Error writing to wrapped writer
-
print
Print an integer. The string produced by
is 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:
print
in classJspWriter
- Parameters:
i
- Theint
to be printed- Throws:
IOException
- Error writing to wrapped writer- See Also:
-
print
Print a long integer. The string produced by
is 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:
print
in classJspWriter
- Parameters:
l
- Thelong
to be printed- Throws:
IOException
- Error writing to wrapped writer- See Also:
-
print
Print a floating-point number. The string produced by
is 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:
print
in classJspWriter
- Parameters:
f
- Thefloat
to be printed- Throws:
IOException
- Error writing to wrapped writer- See Also:
-
print
Print a double-precision floating-point number. The string produced by
is 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:
print
in classJspWriter
- Parameters:
d
- Thedouble
to be printed- Throws:
IOException
- Error writing to wrapped writer- See Also:
-
print
Print 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 the
method.write(int)
- Specified by:
print
in classJspWriter
- Parameters:
s
- The array of chars to be printed- Throws:
NullPointerException
- Ifs
isnull
IOException
- Error writing to wrapped writer
-
print
Print a string. If the argument isnull
then 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 the
method.write(int)
- Specified by:
print
in classJspWriter
- Parameters:
s
- TheString
to be printed- Throws:
IOException
- Error writing to wrapped writer
-
print
Print an object. The string produced by the
method 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:
print
in classJspWriter
- Parameters:
obj
- TheObject
to be printed- Throws:
IOException
- Error writing to wrapped writer- See Also:
-
println
Terminate 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:
println
in classJspWriter
- Throws:
IOException
- Error writing to wrapped writer
-
println
Print a boolean value and then terminate the line. This method behaves as though it invokes
and thenprint(boolean)
.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- Theboolean
to be printed- Throws:
IOException
- Error writing to wrapped writer
-
println
Print a character and then terminate the line. This method behaves as though it invokes
and thenprint(char)
.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- Thechar
to be printed- Throws:
IOException
- Error writing to wrapped writer
-
println
Print an integer and then terminate the line. This method behaves as though it invokes
and thenprint(int)
.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- Theint
to be printed- Throws:
IOException
- Error writing to wrapped writer
-
println
Print a long integer and then terminate the line. This method behaves as though it invokes
and thenprint(long)
.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- Thelong
to be printed- Throws:
IOException
- Error writing to wrapped writer
-
println
Print a floating-point number and then terminate the line. This method behaves as though it invokes
and thenprint(float)
.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- Thefloat
to be printed- Throws:
IOException
- Error writing to wrapped writer
-
println
Print a double-precision floating-point number and then terminate the line. This method behaves as though it invokes
and thenprint(double)
.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- Thedouble
to be printed- Throws:
IOException
- Error writing to wrapped writer
-
println
Print an array of characters and then terminate the line. This method behaves as though it invokes
and thenprint(char[])
.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- Thechar
array to be printed- Throws:
IOException
- Error writing to wrapped writer
-
println
Print a String and then terminate the line. This method behaves as though it invokes
and thenprint(String)
.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- The string to be printed- Throws:
IOException
- Error writing to wrapped writer
-
println
Print an Object and then terminate the line. This method behaves as though it invokes
and thenprint(Object)
.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- The object to be printed- Throws:
IOException
- Error writing to wrapped writer
-
clear
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.- Specified by:
clear
in classJspWriter
- Throws:
IOException
- If there is no wrapped writer
-
clearBuffer
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.- Specified by:
clearBuffer
in classJspWriter
- Throws:
IOException
- Should not happen
-
close
Close 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:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in 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:
getBufferSize
in classJspWriter
- Returns:
- the size of the buffer in bytes, or 0 is unbuffered.
-
getRemaining
public int getRemaining()Description copied from class:javax.servlet.jsp.JspWriter
This method returns the number of unused bytes in the buffer.- Specified by:
getRemaining
in classJspWriter
- Returns:
- the number of bytes unused in the buffer
-
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:
getReader
in classBodyContent
- Returns:
- the value of this BodyJspWriter as a Reader
-
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:
getString
in classBodyContent
- Returns:
- the value of the BodyJspWriter as a String
-
writeOut
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:
writeOut
in 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:
-