org.apache.jasper.runtime

Class JspWriterImpl


public class JspWriterImpl
extends JspWriter

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

Constructor Summary

JspWriterImpl()
JspWriterImpl(ServletResponse response)
Create a buffered character-output stream that uses a default-sized output buffer.
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

void
clear()
Discard the output buffer.
void
clearBuffer()
void
close()
Close the stream.
void
flush()
Flush the stream.
protected void
flushBuffer()
Flush the output buffer to the underlying character stream, without flushing the stream itself.
int
getRemaining()
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.
void
write(String s)
Write a string.
void
write(String s, int off, int len)
Write a portion of a String.
void
write(buf[] )
Write an array of characters.
void
write(cbuf[] , int off, int len)
Write a portion of an array of characters.
void
write(int c)
Write a single character.

Constructor Details

JspWriterImpl

public JspWriterImpl()

JspWriterImpl

public JspWriterImpl(ServletResponse response)
Create a buffered character-output stream that uses a default-sized output buffer.
Parameters:
response - A Servlet Response

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 Response
sz - Output-buffer size, a positive integer

Method Details

clear

public final void clear()
            throws IOException
Discard the output buffer.

clearBuffer

public void clearBuffer()
            throws IOException

close

public void close()
            throws IOException
Close the stream.

flush

public void flush()
            throws IOException
Flush the stream.

flushBuffer

protected final void flushBuffer()
            throws 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.

getRemaining

public int getRemaining()
Returns:
the number of bytes unused in the buffer

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
Parameters:
obj - The Object to be printed

print

public void print(String s)
            throws IOException
Parameters:
s - The String to be printed

print

public void print(boolean b)
            throws IOException
Parameters:
b - The boolean to be printed

print

public void print(char c)
            throws IOException
Parameters:
c - The char to be printed

print

public void print(double d)
            throws IOException
Parameters:
d - The double to be printed

print

public void print(float f)
            throws IOException
Parameters:
f - The float to be printed

print

public void print(int i)
            throws IOException
Parameters:
i - The int to be printed

print

public void print(long l)
            throws IOException
Parameters:
l - The long to be printed

print

public void print(s[] )
            throws IOException
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'). Need to change this from PrintWriter because the default println() writes to the sink directly instead of through the write method...

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

write

public void write(String s)
            throws IOException
Write a string. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.

write

public void write(String s,
                  int off,
                  int len)
            throws IOException
Write a portion of a String.
Parameters:
s - String to be written
off - Offset from which to start reading characters
len - Number of characters to be written

write

public void write(buf[] )
            throws IOException
Write an array of characters. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.

write

public void write(cbuf[] ,
                  int off,
                  int len)
            throws IOException
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.

Parameters:
off - Offset from which to start reading characters
len - Number of characters to write

write

public void write(int c)
            throws IOException
Write a single character.

Copyright B) 2000-2004 Apache Software Foundation. All Rights Reserved.