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
ConstructorDescriptionJspWriterImpl
(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 void
clear()
Clear the contents of the buffer.void
Clears the current contents of the buffer.void
close()
Close the stream, flushing it first.void
flush()
Flush the stream.protected final void
Flush the output buffer to the underlying character stream, without flushing the stream itself.int
This method returns the number of unused bytes in the buffer.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.void
write
(char[] buf) void
write
(char[] cbuf, int off, int len) void
write
(int c) void
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
-true
to automatically flush on buffer full,false
to 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
Description copied from class:jakarta.servlet.jsp.JspWriter
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 an I/O error occurs
-
clearBuffer
Description copied from class:jakarta.servlet.jsp.JspWriter
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
- If an I/O error occurs
-
flush
Description copied from class:jakarta.servlet.jsp.JspWriter
Flush the stream. If the stream has saved any characters from the various write() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte stream, flush it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams.The method may be invoked indirectly if the buffer size is exceeded.
Once a stream has been closed, further write() or flush() invocations will cause an IOException to be thrown.
- Specified by:
flush
in interfaceFlushable
- Specified by:
flush
in classJspWriter
- Throws:
IOException
- If an I/O error occurs
-
close
Description copied from class:jakarta.servlet.jsp.JspWriter
Close the stream, flushing it first.This method needs not be invoked explicitly for the initial JspWriter as the code generated by the JSP container will automatically include a call to close().
Closing a previously-closed stream, unlike flush(), has no effect.
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classJspWriter
- Throws:
IOException
- If an I/O error occurs
-
getRemaining
public int getRemaining()Description copied from class:jakarta.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
-
write
- Overrides:
write
in classWriter
- Throws:
IOException
-
write
- Specified by:
write
in classWriter
- Throws:
IOException
-
write
- Overrides:
write
in classWriter
- Throws:
IOException
-
write
- Overrides:
write
in classWriter
- Throws:
IOException
-
newLine
Description copied from class:jakarta.servlet.jsp.JspWriter
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
- If an I/O error occurs
-
print
Description copied from class:jakarta.servlet.jsp.JspWriter
Print a boolean value. The string produced by
is written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.String.valueOf(boolean)
- Specified by:
print
in classJspWriter
- Parameters:
b
- Theboolean
to be printed- Throws:
IOException
- If an error occurred while writing
-
print
Description copied from class:jakarta.servlet.jsp.JspWriter
Print a character. The character is written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.- Specified by:
print
in classJspWriter
- Parameters:
c
- Thechar
to be printed- Throws:
IOException
- If an error occurred while writing
-
print
Description copied from class:jakarta.servlet.jsp.JspWriter
Print an integer. The string produced by
is written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.String.valueOf(int)
- Specified by:
print
in classJspWriter
- Parameters:
i
- Theint
to be printed- Throws:
IOException
- If an error occurred while writing- See Also:
-
print
Description copied from class:jakarta.servlet.jsp.JspWriter
Print a long integer. The string produced by
is written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.String.valueOf(long)
- Specified by:
print
in classJspWriter
- Parameters:
l
- Thelong
to be printed- Throws:
IOException
- If an error occurred while writing- See Also:
-
print
Description copied from class:jakarta.servlet.jsp.JspWriter
Print a floating-point number. The string produced by
is written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.String.valueOf(float)
- Specified by:
print
in classJspWriter
- Parameters:
f
- Thefloat
to be printed- Throws:
IOException
- If an error occurred while writing- See Also:
-
print
Description copied from class:jakarta.servlet.jsp.JspWriter
Print a double-precision floating-point number. The string produced by
is written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.String.valueOf(double)
- Specified by:
print
in classJspWriter
- Parameters:
d
- Thedouble
to be printed- Throws:
IOException
- If an error occurred while writing- See Also:
-
print
Description copied from class:jakarta.servlet.jsp.JspWriter
Print an array of characters. The characters are written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.- Specified by:
print
in classJspWriter
- Parameters:
s
- The array of chars to be printed- Throws:
IOException
- If an error occurred while writing
-
print
Description copied from class:jakarta.servlet.jsp.JspWriter
Print a string. If the argument isnull
then the string"null"
is printed. Otherwise, the string's characters are written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.- Specified by:
print
in classJspWriter
- Parameters:
s
- TheString
to be printed- Throws:
IOException
- If an error occurred while writing
-
print
Description copied from class:jakarta.servlet.jsp.JspWriter
Print an object. The string produced by the
method is written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.String.valueOf(Object)
- Specified by:
print
in classJspWriter
- Parameters:
obj
- TheObject
to be printed- Throws:
IOException
- If an error occurred while writing- See Also:
-
println
Description copied from class:jakarta.servlet.jsp.JspWriter
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
- If an error occurred while writing
-
println
Description copied from class:jakarta.servlet.jsp.JspWriter
Print a boolean value and then terminate the line. This method behaves as though it invokes
and thenJspWriter.print(boolean)
.JspWriter.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- the boolean to write- Throws:
IOException
- If an error occurred while writing
-
println
Description copied from class:jakarta.servlet.jsp.JspWriter
Print a character and then terminate the line. This method behaves as though it invokes
and thenJspWriter.print(char)
.JspWriter.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- the char to write- Throws:
IOException
- If an error occurred while writing
-
println
Description copied from class:jakarta.servlet.jsp.JspWriter
Print an integer and then terminate the line. This method behaves as though it invokes
and thenJspWriter.print(int)
.JspWriter.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- the int to write- Throws:
IOException
- If an error occurred while writing
-
println
Description copied from class:jakarta.servlet.jsp.JspWriter
Print a long integer and then terminate the line. This method behaves as though it invokes
and thenJspWriter.print(long)
.JspWriter.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- the long to write- Throws:
IOException
- If an error occurred while writing
-
println
Description copied from class:jakarta.servlet.jsp.JspWriter
Print a floating-point number and then terminate the line. This method behaves as though it invokes
and thenJspWriter.print(float)
.JspWriter.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- the float to write- Throws:
IOException
- If an error occurred while writing
-
println
Description copied from class:jakarta.servlet.jsp.JspWriter
Print a double-precision floating-point number and then terminate the line. This method behaves as though it invokes
and thenJspWriter.print(double)
.JspWriter.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- the double to write- Throws:
IOException
- If an error occurred while writing
-
println
Description copied from class:jakarta.servlet.jsp.JspWriter
Print an array of characters and then terminate the line. This method behaves as though it invokesprint(char[])
and thenprintln()
.- Specified by:
println
in classJspWriter
- Parameters:
x
- the char[] to write- Throws:
IOException
- If an error occurred while writing
-
println
Description copied from class:jakarta.servlet.jsp.JspWriter
Print a String and then terminate the line. This method behaves as though it invokes
and thenJspWriter.print(String)
.JspWriter.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- the String to write- Throws:
IOException
- If an error occurred while writing
-
println
Description copied from class:jakarta.servlet.jsp.JspWriter
Print an Object and then terminate the line. This method behaves as though it invokes
and thenJspWriter.print(Object)
.JspWriter.println()
- Specified by:
println
in classJspWriter
- Parameters:
x
- the Object to write- Throws:
IOException
- If an error occurred while writing
-