Package org.apache.jasper.runtime
Class BodyContentImpl
java.lang.Object
java.io.Writer
jakarta.servlet.jsp.JspWriter
jakarta.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 SummaryFields inherited from class jakarta.servlet.jsp.JspWriterautoFlush, bufferSize, DEFAULT_BUFFER, NO_BUFFER, UNBOUNDED_BUFFER
- 
Constructor SummaryConstructorsConstructorDescriptionBodyContentImpl(JspWriter enclosingWriter, boolean limitBuffer, int tagBufferSize) Constructor.
- 
Method SummaryModifier and TypeMethodDescriptionvoidclear()Clear the contents of the buffer.voidClears the current contents of the buffer.voidclose()Close the stream, flushing it first.intThis method returns the size of the buffer used by the JspWriter.Return the value of this BodyJspWriter as a Reader.intThis method returns the number of unused bytes in the buffer.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 an object.voidPrint 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.voidPrint an Object and then terminate the line.voidPrint 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 a string.voidWrite a portion of a String.voidWrite the contents of this BodyJspWriter into a Writer.Methods inherited from class jakarta.servlet.jsp.tagext.BodyContentclearBody, flush, getEnclosingWriterMethods inherited from class jakarta.servlet.jsp.JspWriterisAutoFlushMethods inherited from class java.io.Writerappend, append, append, nullWriter
- 
Constructor Details- 
BodyContentImplConstructor.- Parameters:
- enclosingWriter- The wrapped writer
- limitBuffer-- trueto discard large buffers
- tagBufferSize- the buffer size
 
 
- 
- 
Method Details- 
writeWrite a single character.- Overrides:
- writein class- Writer
- Parameters:
- c- The char to write
- Throws:
- IOException- Error writing to wrapped writer
 
- 
writeWrite 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 class- Writer
- Parameters:
- cbuf- A character array
- off- Offset from which to start reading characters
- len- Number of characters to write
- Throws:
- IOException- Error writing to wrapped writer
 
- 
writeWrite an array of characters. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.- Overrides:
- writein class- Writer
- Parameters:
- buf- Content to write
- Throws:
- IOException- Error writing to wrapped writer
 
- 
writeWrite a portion of a String.- Overrides:
- writein class- Writer
- Parameters:
- s- String to be written
- off- Offset from which to start reading characters
- len- Number of characters to be written
- Throws:
- IOException- Error writing to wrapped writer
 
- 
writeWrite a string. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.- Overrides:
- writein class- Writer
- Parameters:
- s- String to be written
- Throws:
- IOException- Error writing to wrapped writer
 
- 
newLineWrite 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 class- JspWriter
- Throws:
- IOException- Error writing to wrapped writer
 
- 
printPrint a boolean value. The string produced byString.valueOf(boolean)write(int)- Specified by:
- printin class- JspWriter
- Parameters:
- b- The- booleanto be printed
- Throws:
- IOException- Error writing to wrapped writer
 
- 
printPrint 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 thewrite(int)- Specified by:
- printin class- JspWriter
- Parameters:
- c- The- charto be printed
- Throws:
- IOException- Error writing to wrapped writer
 
- 
printPrint an integer. The string produced byString.valueOf(int)write(int)- Specified by:
- printin class- JspWriter
- Parameters:
- i- The- intto be printed
- Throws:
- IOException- Error writing to wrapped writer
- See Also:
 
- 
printPrint a long integer. The string produced byString.valueOf(long)write(int)- Specified by:
- printin class- JspWriter
- Parameters:
- l- The- longto be printed
- Throws:
- IOException- Error writing to wrapped writer
- See Also:
 
- 
printPrint a floating-point number. The string produced byString.valueOf(float)write(int)- Specified by:
- printin class- JspWriter
- Parameters:
- f- The- floatto be printed
- Throws:
- IOException- Error writing to wrapped writer
- See Also:
 
- 
printPrint a double-precision floating-point number. The string produced byString.valueOf(double)write(int)- Specified by:
- printin class- JspWriter
- Parameters:
- d- The- doubleto be printed
- Throws:
- IOException- Error writing to wrapped writer
- See Also:
 
- 
printPrint 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 thewrite(int)- Specified by:
- printin class- JspWriter
- Parameters:
- s- The array of chars to be printed
- Throws:
- NullPointerException- If- sis- null
- IOException- Error writing to wrapped writer
 
- 
printPrint 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 thewrite(int)- Specified by:
- printin class- JspWriter
- Parameters:
- s- The- Stringto be printed
- Throws:
- IOException- Error writing to wrapped writer
 
- 
printPrint an object. The string produced by theString.valueOf(Object)write(int)- Specified by:
- printin class- JspWriter
- Parameters:
- obj- The- Objectto be printed
- Throws:
- IOException- Error writing to wrapped writer
- See Also:
 
- 
printlnTerminate 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 class- JspWriter
- Throws:
- IOException- Error writing to wrapped writer
 
- 
printlnPrint a boolean value and then terminate the line. This method behaves as though it invokesprint(boolean)println()- Specified by:
- printlnin class- JspWriter
- Parameters:
- x- The- booleanto be printed
- Throws:
- IOException- Error writing to wrapped writer
 
- 
printlnPrint a character and then terminate the line. This method behaves as though it invokesprint(char)println()- Specified by:
- printlnin class- JspWriter
- Parameters:
- x- The- charto be printed
- Throws:
- IOException- Error writing to wrapped writer
 
- 
printlnPrint an integer and then terminate the line. This method behaves as though it invokesprint(int)println()- Specified by:
- printlnin class- JspWriter
- Parameters:
- x- The- intto be printed
- Throws:
- IOException- Error writing to wrapped writer
 
- 
printlnPrint a long integer and then terminate the line. This method behaves as though it invokesprint(long)println()- Specified by:
- printlnin class- JspWriter
- Parameters:
- x- The- longto be printed
- Throws:
- IOException- Error writing to wrapped writer
 
- 
printlnPrint a floating-point number and then terminate the line. This method behaves as though it invokesprint(float)println()- Specified by:
- printlnin class- JspWriter
- Parameters:
- x- The- floatto be printed
- Throws:
- IOException- Error writing to wrapped writer
 
- 
printlnPrint a double-precision floating-point number and then terminate the line. This method behaves as though it invokesprint(double)println()- Specified by:
- printlnin class- JspWriter
- Parameters:
- x- The- doubleto be printed
- Throws:
- IOException- Error writing to wrapped writer
 
- 
printlnPrint an array of characters and then terminate the line. This method behaves as though it invokesprint(char[])println()- Specified by:
- printlnin class- JspWriter
- Parameters:
- x- The- chararray to be printed
- Throws:
- IOException- Error writing to wrapped writer
 
- 
printlnPrint a String and then terminate the line. This method behaves as though it invokesprint(String)println()- Specified by:
- printlnin class- JspWriter
- Parameters:
- x- The string to be printed
- Throws:
- IOException- Error writing to wrapped writer
 
- 
printlnPrint an Object and then terminate the line. This method behaves as though it invokesprint(Object)println()- Specified by:
- printlnin class- JspWriter
- Parameters:
- x- The object to be printed
- Throws:
- IOException- Error writing to wrapped writer
 
- 
clearClear 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 class- JspWriter
- Throws:
- IOException- If there is no wrapped writer
 
- 
clearBufferClears 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 class- JspWriter
- Throws:
- IOException- Should not happen
 
- 
closeClose 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 interface- AutoCloseable
- Specified by:
- closein interface- Closeable
- Specified by:
- closein class- JspWriter
- Throws:
- IOException- Error writing to wrapped writer
 
- 
getBufferSizepublic int getBufferSize()This method returns the size of the buffer used by the JspWriter.- Overrides:
- getBufferSizein class- JspWriter
- Returns:
- the size of the buffer in bytes, or 0 is unbuffered.
 
- 
getRemainingpublic int getRemaining()Description copied from class:jakarta.servlet.jsp.JspWriterThis method returns the number of unused bytes in the buffer.- Specified by:
- getRemainingin class- JspWriter
- Returns:
- the number of bytes unused in the buffer
 
- 
getReaderReturn the value of this BodyJspWriter as a Reader. Note: this is after evaluation!! There are no scriptlets, etc in this stream.- Specified by:
- getReaderin class- BodyContent
- Returns:
- the value of this BodyJspWriter as a Reader
 
- 
getStringReturn the value of the BodyJspWriter as a String. Note: this is after evaluation!! There are no scriptlets, etc in this stream.- Specified by:
- getStringin class- BodyContent
- Returns:
- the value of the BodyJspWriter as a String
 
- 
writeOutWrite 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 class- BodyContent
- Parameters:
- out- The writer into which to place the contents of this body evaluation
- Throws:
- IOException- Error writing to writer
 
- 
recycleprotected 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:
 
 
-