Package org.apache.jasper.runtime
Class JspWriterImpl
java.lang.Object
java.io.Writer
jakarta.servlet.jsp.JspWriter
org.apache.jasper.runtime.JspWriterImpl
- 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.
This needs revisiting when the buffering problems in the JSP spec
are fixed -akv
- Author:
- Anil K. Vijendran
-
Field Summary
Fields inherited from class jakarta.servlet.jsp.JspWriter
autoFlush, bufferSize, DEFAULT_BUFFER, NO_BUFFER, UNBOUNDED_BUFFER -
Constructor Summary
ConstructorsConstructorDescriptionJspWriterImpl(ServletResponse response, int sz, boolean autoFlush) Create a new buffered character-output stream that uses an output buffer of the given size. -
Method Summary
Modifier and TypeMethodDescriptionfinal voidclear()Discard the output buffer.voidClears the current contents of the buffer.voidclose()Close the stream.voidflush()Flush the stream.protected final voidFlush the output buffer to the underlying character stream, without flushing the stream itself.intThis method returns the number of unused bytes in the buffer.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.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 portion of a String.Methods inherited from class jakarta.servlet.jsp.JspWriter
getBufferSize, isAutoFlush
-
Constructor Details
-
JspWriterImpl
public JspWriterImpl() -
JspWriterImpl
Create a new buffered character-output stream that uses an output buffer of the given size.- Parameters:
response- A Servlet Responsesz- Output-buffer size, a positive integerautoFlush-trueto automatically flush on buffer full,falseto throw an overflow exception in that case- Throws:
IllegalArgumentException- If sz is <= 0
-
-
Method Details
-
flushBuffer
Flush the output buffer to the underlying character stream, without flushing the stream itself. This method is non-private only so that it may be invoked by PrintStream.- Throws:
IOException- Error writing buffered data
-
clear
Discard the output buffer.- Specified by:
clearin classJspWriter- Throws:
IOException- If an I/O error occurs
-
clearBuffer
Description copied from class:jakarta.servlet.jsp.JspWriterClears 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- If an I/O error occurs
-
flush
Flush the stream.- Specified by:
flushin interfaceFlushable- Specified by:
flushin classJspWriter- Throws:
IOException- If an I/O error occurs
-
close
Close the stream.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein classJspWriter- Throws:
IOException- If an I/O error occurs
-
getRemaining
public int getRemaining()Description copied from class:jakarta.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
-
write
Write a single character.- Overrides:
writein classWriter- Throws:
IOException
-
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
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
-
write
Write an array of characters. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.- Overrides:
writein classWriter- Throws:
IOException
-
write
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
-
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:
newLinein classJspWriter- Throws:
IOException- If an I/O error occurs
-
print
Print 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- If an error occurred while writing
-
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 themethod.write(int)- Specified by:
printin classJspWriter- Parameters:
c- Thecharto be printed- Throws:
IOException- If an error occurred while writing
-
print
Print 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- If an error occurred while writing- See Also:
-
print
Print 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- If an error occurred while writing- See Also:
-
print
Print 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- If an error occurred while writing- See Also:
-
print
Print 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- If an error occurred while writing- 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 themethod.write(int)- Specified by:
printin classJspWriter- Parameters:
s- The array of chars to be printed- Throws:
NullPointerException- IfsisnullIOException- If an error occurred while writing
-
print
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- If an error occurred while writing
-
print
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- If an error occurred while writing- 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'). Need to change this from PrintWriter because the default println() writes to the sink directly instead of through the write method...- Specified by:
printlnin classJspWriter- Throws:
IOException- If an error occurred while writing
-
println
Print a boolean value and then terminate the line. This method behaves as though it invokesand thenprint(boolean).println()- Specified by:
printlnin classJspWriter- Parameters:
x- the boolean to write- Throws:
IOException- If an error occurred while writing
-
println
Print a character and then terminate the line. This method behaves as though it invokesand thenprint(char).println()- Specified by:
printlnin classJspWriter- Parameters:
x- the char to write- Throws:
IOException- If an error occurred while writing
-
println
Print an integer and then terminate the line. This method behaves as though it invokesand thenprint(int).println()- Specified by:
printlnin classJspWriter- Parameters:
x- the int to write- Throws:
IOException- If an error occurred while writing
-
println
Print a long integer and then terminate the line. This method behaves as though it invokesand thenprint(long).println()- Specified by:
printlnin classJspWriter- Parameters:
x- the long to write- Throws:
IOException- If an error occurred while writing
-
println
Print 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- the float to write- Throws:
IOException- If an error occurred while writing
-
println
Print 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- the double to write- Throws:
IOException- If an error occurred while writing
-
println
Print 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- the char[] to write- Throws:
IOException- If an error occurred while writing
-
println
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 write- Throws:
IOException- If an error occurred while writing
-
println
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 write- Throws:
IOException- If an error occurred while writing
-