javax.servlet.jsp
public abstract class JspWriter extends Writer
The actions and template data in a JSP page is written using the JspWriter object that is referenced by the implicit variable out which is initialized automatically using methods in the PageContext object.
This abstract class emulates some of the functionality found in the java.io.BufferedWriter and java.io.PrintWriter classes, however it differs in that it throws java.io.IOException from the print methods while PrintWriter does not.
Buffering
The initial JspWriter object is associated with the PrintWriter object of the ServletResponse in a way that depends on whether the page is or is not buffered. If the page is not buffered, output written to this JspWriter object will be written through to the PrintWriter directly, which will be created if necessary by invoking the getWriter() method on the response object. But if the page is buffered, the PrintWriter object will not be created until the buffer is flushed and operations like setContentType() are legal. Since this flexibility simplifies programming substantially, buffering is the default for JSP pages.
Buffering raises the issue of what to do when the buffer is exceeded. Two approaches can be taken:
Both approaches are valid, and thus both are supported in the JSP technology. The behavior of a page is controlled by the autoFlush attribute, which defaults to true. In general, JSP pages that need to be sure that correct and complete data has been sent to their client may want to set autoFlush to false, with a typical case being that where the client is an application itself. On the other hand, JSP pages that send data that is meaningful even when partially constructed may want to set autoFlush to true; such as when the data is sent for immediate display through a browser. Each application will need to consider their specific needs.
An alternative considered was to make the buffer size unbounded; but, this had the disadvantage that runaway computations would consume an unbounded amount of resources.
The "out" implicit variable of a JSP implementation class is of this type. If the page directive selects autoflush="true" then all the I/O operations on this class shall automatically flush the contents of the buffer if an overflow condition would result if the current operation were performed without a flush. If autoflush="false" then all the I/O operations on this class shall throw an IOException if performing the current operation would result in a buffer overflow condition.
See Also: java.io.Writer java.io.BufferedWriter java.io.PrintWriter
Field Summary | |
---|---|
protected boolean | autoFlush
Whether the JspWriter is autoflushing. |
protected int | bufferSize
The size of the buffer used by the JspWriter. |
static int | DEFAULT_BUFFER
Constant indicating that the Writer is buffered and is using the
implementation default buffer size. |
static int | NO_BUFFER
Constant indicating that the Writer is not buffering output. |
static int | UNBOUNDED_BUFFER
Constant indicating that the Writer is buffered and is unbounded; this
is used in BodyContent. |
Constructor Summary | |
---|---|
protected | JspWriter(int bufferSize, boolean autoFlush)
Protected constructor.
|
Method Summary | |
---|---|
abstract void | clear()
Clear the contents of the buffer. |
abstract void | clearBuffer()
Clears the current contents of the buffer. |
abstract void | close()
Close the stream, flushing it first.
|
abstract void | flush()
Flush the stream. |
int | getBufferSize()
This method returns the size of the buffer used by the JspWriter.
|
abstract int | getRemaining()
This method returns the number of unused bytes in the buffer.
|
boolean | isAutoFlush()
This method indicates whether the JspWriter is autoFlushing.
|
abstract void | newLine()
Write a line separator. |
abstract void | print(boolean b)
Print a boolean value. |
abstract void | print(char c)
Print a character. |
abstract void | print(int i)
Print an integer. |
abstract void | print(long l)
Print a long integer. |
abstract void | print(float f)
Print a floating-point number. |
abstract void | print(double d)
Print a double-precision floating-point number. |
abstract void | print(char[] s)
Print an array of characters. |
abstract void | print(String s)
Print a string. |
abstract void | print(Object obj)
Print an object. |
abstract void | println()
Terminate the current line by writing the line separator string. |
abstract void | println(boolean x)
Print a boolean value and then terminate the line. |
abstract void | println(char x)
Print a character and then terminate the line. |
abstract void | println(int x)
Print an integer and then terminate the line. |
abstract void | println(long x)
Print a long integer and then terminate the line. |
abstract void | println(float x)
Print a floating-point number and then terminate the line. |
abstract void | println(double x)
Print a double-precision floating-point number and then terminate the
line. |
abstract void | println(char[] x)
Print an array of characters and then terminate the line. |
abstract void | println(String x)
Print a String and then terminate the line. |
abstract void | println(Object x)
Print an Object and then terminate the line. |
Parameters: bufferSize the size of the buffer to be used by the JspWriter autoFlush whether the JspWriter should be autoflushing
Throws: IOException If an I/O error occurs
Throws: IOException If an I/O error occurs
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.
Throws: IOException If an I/O error occurs
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.
Throws: IOException If an I/O error occurs
Returns: the size of the buffer in bytes, or 0 is unbuffered.
Returns: the number of bytes unused in the buffer
Returns: if this JspWriter is auto flushing or throwing IOExceptions on buffer overflow conditions
Throws: IOException If an I/O error occurs
{@link
java.lang.String#valueOf(boolean)}
is written to the
JspWriter's buffer or, if no buffer is used, directly to the
underlying writer.
Parameters: b The boolean
to be printed
Throws: java.io.IOException If an error occured while writing
Parameters: c The char
to be printed
Throws: java.io.IOException If an error occured while writing
{@link
java.lang.String#valueOf(int)}
is written to the
JspWriter's buffer or, if no buffer is used, directly to the
underlying writer.
Parameters: i The int
to be printed
Throws: java.io.IOException If an error occured while writing
See Also: java.lang.Integer#toString(int)
{@link
java.lang.String#valueOf(long)}
is written to the
JspWriter's buffer or, if no buffer is used, directly to the
underlying writer.
Parameters: l The long
to be printed
Throws: java.io.IOException If an error occured while writing
See Also: java.lang.Long#toString(long)
{@link
java.lang.String#valueOf(float)}
is written to the
JspWriter's buffer or, if no buffer is used, directly to the
underlying writer.
Parameters: f The float
to be printed
Throws: java.io.IOException If an error occured while writing
See Also: java.lang.Float#toString(float)
{@link java.lang.String#valueOf(double)}
is written to
the JspWriter's buffer or, if no buffer is used, directly to the
underlying writer.
Parameters: d The double
to be printed
Throws: java.io.IOException If an error occured while writing
See Also: java.lang.Double#toString(double)
Parameters: s The array of chars to be printed
Throws: NullPointerException If s
is null
java.io.IOException If an error occured while writing
null
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.
Parameters: s The String
to be printed
Throws: java.io.IOException If an error occured while writing
{@link
java.lang.String#valueOf(Object)}
method is written to the
JspWriter's buffer or, if no buffer is used, directly to the
underlying writer.
Parameters: obj The Object
to be printed
Throws: java.io.IOException If an error occured while writing
See Also: java.lang.Object#toString()
line.separator
, and is not necessarily a single newline
character ('\n'
).Throws: java.io.IOException If an error occured while writing
{@link #print(boolean)}
and then
{@link #println()}
.
Parameters: x the boolean to write
Throws: java.io.IOException If an error occured while writing
{@link #print(char)}
and then {@link
#println()}
.
Parameters: x the char to write
Throws: java.io.IOException If an error occured while writing
{@link #print(int)}
and then {@link
#println()}
.
Parameters: x the int to write
Throws: java.io.IOException If an error occured while writing
{@link #print(long)}
and then
{@link #println()}
.
Parameters: x the long to write
Throws: java.io.IOException If an error occured while writing
{@link #print(float)}
and then
{@link #println()}
.
Parameters: x the float to write
Throws: java.io.IOException If an error occured while writing
{@link
#print(double)}
and then {@link #println()}
.
Parameters: x the double to write
Throws: java.io.IOException If an error occured while writing
print(char[])
and then
println()
.
Parameters: x the char[] to write
Throws: java.io.IOException If an error occured while writing
{@link #print(String)}
and then
{@link #println()}
.
Parameters: x the String to write
Throws: java.io.IOException If an error occured while writing
{@link #print(Object)}
and then
{@link #println()}
.
Parameters: x the Object to write
Throws: java.io.IOException If an error occured while writing