javax.servlet.jsp

Class JspWriter

Known Direct Subclasses:
BodyContent

public abstract class JspWriter
extends java.io.Writer

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 with PrintWriter does not.

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 fluch 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 opertion would result in a buffer overflow condition.

See Also:
java.io.Writer, java.io.BufferedWriter, java.io.PrintWriter

Field Summary

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
protected boolean
autoFlush
protected int
bufferSize

Constructor Summary

JspWriter(int bufferSize, boolean autoFlush)
protected constructor.

Method Summary

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.
int
getBufferSize()
int
getRemaining()
boolean
isAutoFlush()
void
newLine()
Write a line separator.
void
print(Object obj)
Print an object.
void
print(String s)
Print a string.
void
print(boolean b)
Print a boolean value.
void
print(char c)
Print a character.
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(s[] )
Print an array of characters.
void
println()
Terminate the current line by writing the line separator string.
void
println(Object x)
Print an Object and then terminate the line.
void
println(String x)
Print a String and then terminate the line.
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(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(x[] )
Print an array of characters and then terminate the line.

Field Details

DEFAULT_BUFFER

public static final int DEFAULT_BUFFER
constant indicating that the Writer is buffered and is using the implementation default buffer size

Field Value:
-1


NO_BUFFER

public static final int NO_BUFFER
constant indicating that the Writer is not buffering output

Field Value:
0


UNBOUNDED_BUFFER

public static final int UNBOUNDED_BUFFER
constant indicating that the Writer is buffered and is unbounded; this is used in BodyContent

Field Value:
-2


autoFlush

protected boolean autoFlush


bufferSize

protected int bufferSize

Constructor Details

JspWriter

protected JspWriter(int bufferSize,
                    boolean autoFlush)
protected constructor.

Method Details

clear

public void clear()
            throws IOException
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 IOException
Clears the current contents of the buffer. Unlike clear(), this mehtod will not throw an IOException if the buffer has already been flushed. It merely clears the current content of the buffer and returns.


close

public void close()
            throws IOException
Close 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.


flush

public void flush()
            throws IOException
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.


getBufferSize

public int getBufferSize()

Returns:
the size of the buffer in bytes, or 0 is unbuffered.


getRemaining

public int getRemaining()

Returns:
the number of bytes unused in the buffer


isAutoFlush

public boolean isAutoFlush()

Returns:
if this JspWriter is auto flushing or throwing IOExceptions on buffer overflow conditions


newLine

public void newLine()
            throws IOException
Write a line separator. The line separator string is defined by the system property line.separator, and is not necessarily a single newline ('\n') character.


print

public void print(Object obj)
            throws IOException
Print an object. The string produced by the java.lang.String.valueOf(Object) method is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:
obj - The Object to be printed

See Also:
java.lang.Object.toString()


print

public void print(String s)
            throws IOException
Print a string. If the argument is null then 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 the write(int) method.

Parameters:
s - The String to be printed


print

public void print(boolean b)
            throws IOException
Print a boolean value. The string produced by java.lang.String.valueOf(boolean) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:
b - The boolean to be printed


print

public void print(char c)
            throws IOException
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 the write(int) method.

Parameters:
c - The char to be printed


print

public void print(double d)
            throws IOException
Print a double-precision floating-point number. The string produced by java.lang.String.valueOf(double) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:
d - The double to be printed

See Also:
java.lang.Double.toString(double)


print

public void print(float f)
            throws IOException
Print a floating-point number. The string produced by java.lang.String.valueOf(float) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:
f - The float to be printed

See Also:
java.lang.Float.toString(float)


print

public void print(int i)
            throws IOException
Print an integer. The string produced by java.lang.String.valueOf(int) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:
i - The int to be printed

See Also:
java.lang.Integer.toString(int)


print

public void print(long l)
            throws IOException
Print a long integer. The string produced by java.lang.String.valueOf(long) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters:
l - The long to be printed

See Also:
java.lang.Long.toString(long)


print

public void print(s[] )
            throws IOException
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 the write(int) method.

Parameters:


println

public void println()
            throws IOException
Terminate the current line by writing the line separator string. The line separator string is defined by the system property line.separator, and is not necessarily a single newline character ('\n').


println

public void println(Object x)
            throws IOException


println

public void println(String x)
            throws IOException


println

public void println(boolean x)
            throws IOException


println

public void println(char x)
            throws IOException


println

public void println(double x)
            throws IOException


println

public void println(float x)
            throws IOException


println

public void println(int x)
            throws IOException


println

public void println(long x)
            throws IOException


println

public void println(x[] )
            throws IOException


Copyright © 1999-2000 The Apache Software Foundation. All Rights Reserved.