org.apache.velocity.tools.view.jsp.jspimpl
Class JspWriterImpl

java.lang.Object
  extended by java.io.Writer
      extended by javax.servlet.jsp.JspWriter
          extended by org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
All Implemented Interfaces:
Closeable, Flushable, Appendable

public class JspWriterImpl
extends JspWriter

Copied and modified from Tomcat 6.0.x source. 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

Field Summary
 
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
JspWriterImpl(Writer out)
          Create a buffered character-output stream that uses a default-sized output buffer.
 
Method Summary
 void clear()
          Discard the output buffer.
 void clearBuffer()
           
 void close()
          Close the stream.
 void flush()
          Flush the stream.
 int getRemaining()
           
 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(Object obj)
          Print an object.
 void print(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(Object x)
          Print an Object and then terminate the line.
 void println(String x)
          Print a String and then terminate the line.
 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(String s)
          Write a string.
 void write(String s, int off, int len)
          Write a portion of a String.
 
Methods inherited from class javax.servlet.jsp.JspWriter
getBufferSize, isAutoFlush
 
Methods inherited from class java.io.Writer
append, append, append
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JspWriterImpl

public JspWriterImpl(Writer out)
Create a buffered character-output stream that uses a default-sized output buffer.

Parameters:
out - The writer.
Method Detail

clear

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

Specified by:
clear in class JspWriter
Throws:
IOException

clearBuffer

public void clearBuffer()
                 throws IOException
Specified by:
clearBuffer in class JspWriter
Throws:
IOException

flush

public void flush()
           throws IOException
Flush the stream.

Specified by:
flush in interface Flushable
Specified by:
flush in class JspWriter
Throws:
IOException

close

public void close()
           throws IOException
Close the stream.

Specified by:
close in interface Closeable
Specified by:
close in class JspWriter
Throws:
IOException

getRemaining

public int getRemaining()
Specified by:
getRemaining in class JspWriter
Returns:
the number of bytes unused in the buffer

write

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

Overrides:
write in class Writer
Throws:
IOException

write

public void write(char[] 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.

Specified by:
write in class Writer
Parameters:
cbuf - A character array
off - Offset from which to start reading characters
len - Number of characters to write
Throws:
IOException

write

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

Overrides:
write in class Writer
Throws:
IOException

write

public void write(String s,
                  int off,
                  int len)
           throws IOException
Write a portion of a String.

Overrides:
write in class Writer
Parameters:
s - String to be written
off - Offset from which to start reading characters
len - Number of characters to be written
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.

Overrides:
write in class Writer
Throws:
IOException

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.

Specified by:
newLine in class JspWriter
Throws:
IOException - If an I/O error occurs

print

public void print(boolean b)
           throws 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 class JspWriter
Parameters:
b - The boolean to be printed
Throws:
IOException

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.

Specified by:
print in class JspWriter
Parameters:
c - The char to be printed
Throws:
IOException

print

public void print(int i)
           throws 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 class JspWriter
Parameters:
i - The int to be printed
Throws:
IOException

print

public void print(long l)
           throws 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 class JspWriter
Parameters:
l - The long to be printed
Throws:
IOException

print

public void print(float f)
           throws 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 class JspWriter
Parameters:
f - The float to be printed
Throws:
IOException

print

public void print(double d)
           throws 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 class JspWriter
Parameters:
d - The double to be printed
Throws:
IOException

print

public void print(char[] 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.

Specified by:
print in class JspWriter
Parameters:
s - The array of chars to be printed
Throws:
NullPointerException - If s is null
IOException

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.

Specified by:
print in class JspWriter
Parameters:
s - The String to be printed
Throws:
IOException

print

public void print(Object obj)
           throws 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 class JspWriter
Parameters:
obj - The Object to be printed
Throws:
IOException

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

Specified by:
println in class JspWriter
Throws:
IOException

println

public void println(boolean x)
             throws 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 class JspWriter
Throws:
IOException

println

public void println(char x)
             throws 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 class JspWriter
Throws:
IOException

println

public void println(int x)
             throws 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 class JspWriter
Throws:
IOException

println

public void println(long x)
             throws 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 class JspWriter
Throws:
IOException

println

public void println(float x)
             throws 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 class JspWriter
Throws:
IOException

println

public void println(double x)
             throws 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 class JspWriter
Throws:
IOException

println

public void println(char[] x)
             throws 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 class JspWriter
Throws:
IOException

println

public void println(String x)
             throws 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 class JspWriter
Throws:
IOException

println

public void println(Object x)
             throws 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 class JspWriter
Throws:
IOException


Copyright © 2002-2011 The Apache Software Foundation. All Rights Reserved.