org.tp23.jasper.runtime
Class ObjectJspWriterImpl

java.lang.Object
  |
  +--java.io.Writer
        |
        +--javax.servlet.jsp.JspWriter
              |
              +--org.tp23.jasper.runtime.ObjectJspWriterImpl

All Implemented Interfaces:

ObjectJspWriter

public class ObjectJspWriterImpl

extends javax.servlet.jsp.JspWriter

implements ObjectJspWriter

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 This probably needs removing altogether and just living with a simple StringWriter At present is is here so there is a writer that conforms to JspWriter to keep things simple. This is only the frame work of the Apache stuff it has all been hacked. It is now just a proxy for the ClearableStringWriter with some utility print methods

Author:

Anil K. Vijendran, Paul Hinds

Field Summary

protected Destination	destination Description of the Field
protected ClearableStringWriter	out Description of the Field

Fields inherited from class javax.servlet.jsp.JspWriter

autoFlush, bufferSize, DEFAULT_BUFFER, NO_BUFFER, UNBOUNDED_BUFFER

Fields inherited from class java.io.Writer

lock

Constructor Summary

ObjectJspWriterImpl()
Constructor for the ObjectJspWriterImpl object

ObjectJspWriterImpl(Destination destination)
Constructor for the ObjectJspWriterImpl object

Method Summary

void	clear() Discard the output buffer.
void	clearBuffer() Description of the Method
void	close() Close the stream.
void	ensureOpen() check to make sure that the stream has not been closed
void	flush() Flush the stream.
void	flushBuffer() Flush the output buffer to the underlying character stream, without flushing the stream itself.
int	getBufferSize()
Destination	getDestination()
int	getRemaining()
void	init(Destination destination, int sz, boolean autoFlush) Description of the Method
void	initOut() Description of the Method
boolean	isAutoFlush()
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	recycle() Package-level access
void	write(char[] buf) Write an array of characters.
void	write(char[] cbuf, int off, int len) Write a portion of an array of characters.
void	write(int c) Write a single character.
void	write(java.lang.String s) Write a string.
void	write(java.lang.String s, int off, int len) Write a portion of a String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

out

protected ClearableStringWriter out

Description of the Field

destination

protected Destination destination

Description of the Field

Constructor Detail

ObjectJspWriterImpl

public ObjectJspWriterImpl()

Constructor for the ObjectJspWriterImpl object

ObjectJspWriterImpl

public ObjectJspWriterImpl(Destination destination)

Constructor for the ObjectJspWriterImpl object

Parameters:

destination - Description of Parameter

Method Detail

getRemaining

public int getRemaining()

Specified by:

getRemaining in interface ObjectJspWriter

Overrides:

getRemaining in class javax.servlet.jsp.JspWriter

Returns:

the number of bytes unused in the buffer

clear

public final void clear()
                 throws java.io.IOException

Discard the output buffer.

Specified by:

clear in interface ObjectJspWriter

Overrides:

clear in class javax.servlet.jsp.JspWriter

Throws:

java.io.IOException - Description of Exception

clearBuffer

public void clearBuffer()
                 throws java.io.IOException

Description of the Method

Specified by:

clearBuffer in interface ObjectJspWriter

Overrides:

clearBuffer in class javax.servlet.jsp.JspWriter

Throws:

java.io.IOException - Description of Exception

flush

public void flush()
           throws java.io.IOException

Flush the stream.

Specified by:

flush in interface ObjectJspWriter

Overrides:

flush in class javax.servlet.jsp.JspWriter

Throws:

java.io.IOException - Description of Exception

close

public void close()
           throws java.io.IOException

Close the stream.

Specified by:

close in interface ObjectJspWriter

Overrides:

close in class javax.servlet.jsp.JspWriter

Throws:

java.io.IOException - Description of Exception

write

public void write(int c)
           throws java.io.IOException

Write a single character.

Specified by:

write in interface ObjectJspWriter

Overrides:

write in class java.io.Writer

Parameters:

c - Description of Parameter

Throws:

java.io.IOException - Description of Exception

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws java.io.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 DiscardableBufferedWriter s will not copy data unnecessarily.

Specified by:

write in interface ObjectJspWriter

Overrides:

write in class java.io.Writer

Parameters:

cbuf - A character array

off - Offset from which to start reading characters

len - Number of characters to write

Throws:

java.io.IOException - Description of Exception

write

public void write(char[] buf)
           throws java.io.IOException

Write an array of characters. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.

Specified by:

write in interface ObjectJspWriter

Overrides:

write in class java.io.Writer

Parameters:

buf - Description of Parameter

Throws:

java.io.IOException - Description of Exception

write

public void write(java.lang.String s,
                  int off,
                  int len)
           throws java.io.IOException

Write a portion of a String.

Specified by:

write in interface ObjectJspWriter

Overrides:

write in class java.io.Writer

Parameters:

s - String to be written

off - Offset from which to start reading characters

len - Number of characters to be written

Throws:

java.io.IOException - Description of Exception

write

public void write(java.lang.String s)
           throws java.io.IOException

Write a string. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.

Specified by:

write in interface ObjectJspWriter

Overrides:

write in class java.io.Writer

Parameters:

s - Description of Parameter

Throws:

java.io.IOException - Description of Exception

newLine

public void newLine()
             throws java.io.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.

Specified by:

newLine in interface ObjectJspWriter

Overrides:

newLine in class javax.servlet.jsp.JspWriter

Throws:

java.io.IOException - If an I/O error occurs

print

public void print(boolean b)
           throws java.io.IOException

Print a boolean value. The string produced by 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.

Specified by:

print in interface ObjectJspWriter

Overrides:

print in class javax.servlet.jsp.JspWriter

Parameters:

b - The boolean to be printed

Throws:

java.io.IOException - Description of Exception

print

public void print(char c)
           throws java.io.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.

Specified by:

print in interface ObjectJspWriter

Overrides:

print in class javax.servlet.jsp.JspWriter

Parameters:

c - The char to be printed

Throws:

java.io.IOException - Description of Exception

print

public void print(int i)
           throws java.io.IOException

Print an integer. The string produced by 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.

Specified by:

print in interface ObjectJspWriter

Overrides:

print in class javax.servlet.jsp.JspWriter

Parameters:

i - The int to be printed

Throws:

java.io.IOException - Description of Exception

See Also:

java.lang.Integer#toString(int)

print

public void print(long l)
           throws java.io.IOException

Print a long integer. The string produced by 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.

Specified by:

print in interface ObjectJspWriter

Overrides:

print in class javax.servlet.jsp.JspWriter

Parameters:

l - The long to be printed

Throws:

java.io.IOException - Description of Exception

See Also:

java.lang.Long#toString(long)

print

public void print(float f)
           throws java.io.IOException

Print a floating-point number. The string produced by 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.

Specified by:

print in interface ObjectJspWriter

Overrides:

print in class javax.servlet.jsp.JspWriter

Parameters:

f - The float to be printed

Throws:

java.io.IOException - Description of Exception

See Also:

java.lang.Float#toString(float)

print

public void print(double d)
           throws java.io.IOException

Print a double-precision floating-point number. The string produced by 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.

Specified by:

print in interface ObjectJspWriter

Overrides:

print in class javax.servlet.jsp.JspWriter

Parameters:

d - The double to be printed

Throws:

java.io.IOException - Description of Exception

See Also:

java.lang.Double#toString(double)

print

public void print(char[] s)
           throws java.io.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.

Specified by:

print in interface ObjectJspWriter

Overrides:

print in class javax.servlet.jsp.JspWriter

Parameters:

s - The array of chars to be printed

Throws:

java.io.IOException - Description of Exception

NullPointerException - If s is null

print

public void print(java.lang.String s)
           throws java.io.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.

Specified by:

print in interface ObjectJspWriter

Overrides:

print in class javax.servlet.jsp.JspWriter

Parameters:

s - The String to be printed

Throws:

java.io.IOException - Description of Exception

print

public void print(java.lang.Object obj)
           throws java.io.IOException

Print an object. The string produced by the 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.

Specified by:

print in interface ObjectJspWriter

Overrides:

print in class javax.servlet.jsp.JspWriter

Parameters:

obj - The Object to be printed

Throws:

java.io.IOException - Description of Exception

See Also:

Object.toString()

println

public void println()
             throws java.io.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...

Specified by:

println in interface ObjectJspWriter

Overrides:

println in class javax.servlet.jsp.JspWriter

Throws:

java.io.IOException - Description of Exception

println

public void println(boolean x)
             throws java.io.IOException

Print a boolean value and then terminate the line. This method behaves as though it invokes print(boolean) and then println() .

Specified by:

println in interface ObjectJspWriter

Overrides:

println in class javax.servlet.jsp.JspWriter

Parameters:

x - Description of Parameter

Throws:

java.io.IOException - Description of Exception

println

public void println(char x)
             throws java.io.IOException

Print a character and then terminate the line. This method behaves as though it invokes print(char) and then println() .

Specified by:

println in interface ObjectJspWriter

Overrides:

println in class javax.servlet.jsp.JspWriter

Parameters:

x - Description of Parameter

Throws:

java.io.IOException - Description of Exception

println

public void println(int x)
             throws java.io.IOException

Print an integer and then terminate the line. This method behaves as though it invokes print(int) and then println() .

Specified by:

println in interface ObjectJspWriter

Overrides:

println in class javax.servlet.jsp.JspWriter

Parameters:

x - Description of Parameter

Throws:

java.io.IOException - Description of Exception

println

public void println(long x)
             throws java.io.IOException

Print a long integer and then terminate the line. This method behaves as though it invokes print(long) and then println() .

Specified by:

println in interface ObjectJspWriter

Overrides:

println in class javax.servlet.jsp.JspWriter

Parameters:

x - Description of Parameter

Throws:

java.io.IOException - Description of Exception

println

public void println(float x)
             throws java.io.IOException

Print a floating-point number and then terminate the line. This method behaves as though it invokes print(float) and then println() .

Specified by:

println in interface ObjectJspWriter

Overrides:

println in class javax.servlet.jsp.JspWriter

Parameters:

x - Description of Parameter

Throws:

java.io.IOException - Description of Exception

println

public void println(double x)
             throws java.io.IOException

Print a double-precision floating-point number and then terminate the line. This method behaves as though it invokes print(double) and then println() .

Specified by:

println in interface ObjectJspWriter

Overrides:

println in class javax.servlet.jsp.JspWriter

Parameters:

x - Description of Parameter

Throws:

java.io.IOException - Description of Exception

println

public void println(char[] x)
             throws java.io.IOException

Print an array of characters and then terminate the line. This method behaves as though it invokes print(char[]) and then println() .

Specified by:

println in interface ObjectJspWriter

Overrides:

println in class javax.servlet.jsp.JspWriter

Parameters:

x - Description of Parameter

Throws:

java.io.IOException - Description of Exception

println

public void println(java.lang.String x)
             throws java.io.IOException

Print a String and then terminate the line. This method behaves as though it invokes print(String) and then println() .

Specified by:

println in interface ObjectJspWriter

Overrides:

println in class javax.servlet.jsp.JspWriter

Parameters:

x - Description of Parameter

Throws:

java.io.IOException - Description of Exception

println

public void println(java.lang.Object x)
             throws java.io.IOException

Print an Object and then terminate the line. This method behaves as though it invokes print(Object) and then println() .

Specified by:

println in interface ObjectJspWriter

Overrides:

println in class javax.servlet.jsp.JspWriter

Parameters:

x - Description of Parameter

Throws:

java.io.IOException - Description of Exception

flushBuffer

public 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.

Specified by:

flushBuffer in interface ObjectJspWriter

Throws:

java.io.IOException - Description of Exception

initOut

public void initOut()
             throws java.io.IOException

Description of the Method

Specified by:

initOut in interface ObjectJspWriter

Throws:

java.io.IOException - Description of Exception

ensureOpen

public void ensureOpen()
                throws java.io.IOException

check to make sure that the stream has not been closed

Specified by:

ensureOpen in interface ObjectJspWriter

Throws:

java.io.IOException - Description of Exception

init

public void init(Destination destination,
                 int sz,
                 boolean autoFlush)
          throws java.io.IOException

Description of the Method

Specified by:

init in interface ObjectJspWriter

Parameters:

destination - Description of Parameter

sz - Description of Parameter

autoFlush - Description of Parameter

Throws:

java.io.IOException - Description of Exception

recycle

public void recycle()

Package-level access

Specified by:

recycle in interface ObjectJspWriter

getDestination

public Destination getDestination()

Specified by:

getDestination in interface ObjectJspWriter

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ObjectJspWriter

Overrides:

getBufferSize in class javax.servlet.jsp.JspWriter

isAutoFlush

public boolean isAutoFlush()

Specified by:

isAutoFlush in interface ObjectJspWriter

Overrides:

isAutoFlush in class javax.servlet.jsp.JspWriter