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:
java.io.Closeable
,java.io.Flushable
,java.lang.Appendable
,java.lang.AutoCloseable
public class JspWriterImpl extends JspWriter
Write text to a character-output stream, buffering characters to provide efficient writing of single characters, arrays, and strings. Provide support for discarding 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
Constructors Constructor Description JspWriterImpl()
JspWriterImpl(ServletResponse response, int sz, boolean autoFlush)
Create a new buffered character-output stream that uses an output buffer of the given size.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Clear the contents of the buffer.void
clearBuffer()
Clears the current contents of the buffer.void
close()
Close the stream, flushing it first.void
flush()
Flush the stream.protected void
flushBuffer()
Flush the output buffer to the underlying character stream, without flushing the stream itself.int
getRemaining()
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(java.lang.Object obj)
Print an object.void
print(java.lang.String s)
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
println(java.lang.Object x)
Print an Object and then terminate the line.void
println(java.lang.String x)
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
write(java.lang.String s, int off, int len)
-
Methods inherited from class jakarta.servlet.jsp.JspWriter
getBufferSize, isAutoFlush
-
-
-
-
Constructor Detail
-
JspWriterImpl
public JspWriterImpl()
-
JspWriterImpl
public JspWriterImpl(ServletResponse response, int sz, boolean autoFlush)
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:
java.lang.IllegalArgumentException
- If sz is <= 0
-
-
Method Detail
-
flushBuffer
protected final void flushBuffer() throws java.io.IOException
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:
java.io.IOException
- Error writing buffered data
-
clear
public final void clear() throws java.io.IOException
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.
-
clearBuffer
public void clearBuffer() throws java.io.IOException
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:
java.io.IOException
- If an I/O error occurs
-
flush
public void flush() throws java.io.IOException
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.
-
close
public void close() throws java.io.IOException
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.
-
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
public void write(int c) throws java.io.IOException
- Overrides:
write
in classjava.io.Writer
- Throws:
java.io.IOException
-
write
public void write(char[] cbuf, int off, int len) throws java.io.IOException
- Specified by:
write
in classjava.io.Writer
- Throws:
java.io.IOException
-
write
public void write(char[] buf) throws java.io.IOException
- Overrides:
write
in classjava.io.Writer
- Throws:
java.io.IOException
-
write
public void write(java.lang.String s, int off, int len) throws java.io.IOException
- Overrides:
write
in classjava.io.Writer
- Throws:
java.io.IOException
-
newLine
public void newLine() throws java.io.IOException
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.
-
print
public void print(boolean b) throws java.io.IOException
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)
-
print
public void print(char c) throws java.io.IOException
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.
-
print
public void print(int i) throws java.io.IOException
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)
-
print
public void print(long l) throws java.io.IOException
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)
-
print
public void print(float f) throws java.io.IOException
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)
-
print
public void print(double d) throws java.io.IOException
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)
-
print
public void print(char[] s) throws java.io.IOException
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.
-
print
public void print(java.lang.String s) throws java.io.IOException
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.
-
print
public void print(java.lang.Object obj) throws java.io.IOException
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)
-
println
public void println() throws java.io.IOException
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'
).
-
println
public void println(boolean x) throws java.io.IOException
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()
-
println
public void println(char x) throws java.io.IOException
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()
-
println
public void println(int x) throws java.io.IOException
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()
-
println
public void println(long x) throws java.io.IOException
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()
-
println
public void println(float x) throws java.io.IOException
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()
-
println
public void println(double x) throws java.io.IOException
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()
-
println
public void println(char[] x) throws java.io.IOException
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()
.
-
println
public void println(java.lang.String x) throws java.io.IOException
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()
-
println
public void println(java.lang.Object x) throws java.io.IOException
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()
-
-