Apache Tomcat 6.0.39

org.apache.jasper.runtime
Class JspWriterImpl

java.lang.Object
  extended by java.io.Writer
      extended by javax.servlet.jsp.JspWriter
          extended by org.apache.jasper.runtime.JspWriterImpl
All Implemented Interfaces:
java.io.Closeable, java.io.Flushable, java.lang.Appendable

public class JspWriterImpl
extends javax.servlet.jsp.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

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()
           
JspWriterImpl(javax.servlet.ServletResponse response)
          Create a buffered character-output stream that uses a default-sized output buffer.
JspWriterImpl(javax.servlet.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()
          Clears the current contents of the buffer.
 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()
          This method returns the number of unused bytes in the buffer.
 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 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 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()

JspWriterImpl

public JspWriterImpl(javax.servlet.ServletResponse response)
Create a buffered character-output stream that uses a default-sized output buffer.

Parameters:
response - A Servlet Response

JspWriterImpl

public JspWriterImpl(javax.servlet.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
Throws:
java.lang.IllegalArgumentException - If sz is <= 0
Method Detail

flushBuffer

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

Throws:
java.io.IOException

clear

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

Specified by:
clear in class javax.servlet.jsp.JspWriter
Throws:
java.io.IOException - If an I/O error occurs

clearBuffer

public void clearBuffer()
                 throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
Clears the current contents of the buffer. Unlike clear(), this method will not throw an IOException if the buffer has already been flushed. It merely clears the current content of the buffer and returns.

Specified by:
clearBuffer in class javax.servlet.jsp.JspWriter
Throws:
java.io.IOException - If an I/O error occurs

flush

public void flush()
           throws java.io.IOException
Flush the stream.

Specified by:
flush in interface java.io.Flushable
Specified by:
flush in class javax.servlet.jsp.JspWriter
Throws:
java.io.IOException - If an I/O error occurs

close

public void close()
           throws java.io.IOException
Close the stream.

Specified by:
close in interface java.io.Closeable
Specified by:
close in class javax.servlet.jsp.JspWriter
Throws:
java.io.IOException - If an I/O error occurs

getRemaining

public int getRemaining()
Description copied from class: javax.servlet.jsp.JspWriter
This method returns the number of unused bytes in the buffer.

Specified by:
getRemaining in class javax.servlet.jsp.JspWriter
Returns:
the number of bytes unused in the buffer

write

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

Overrides:
write in class java.io.Writer
Throws:
java.io.IOException

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 DiscardableBufferedWriters will not copy data unnecessarily.

Specified by:
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

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.

Overrides:
write in class java.io.Writer
Throws:
java.io.IOException

write

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

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

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.

Overrides:
write in class java.io.Writer
Throws:
java.io.IOException

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 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 class javax.servlet.jsp.JspWriter
Parameters:
b - The boolean to be printed
Throws:
java.io.IOException - If an error occured while writing

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 class javax.servlet.jsp.JspWriter
Parameters:
c - The char to be printed
Throws:
java.io.IOException - If an error occured while writing

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 class javax.servlet.jsp.JspWriter
Parameters:
i - The int to be printed
Throws:
java.io.IOException - If an error occured while writing
See Also:
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 class javax.servlet.jsp.JspWriter
Parameters:
l - The long to be printed
Throws:
java.io.IOException - If an error occured while writing
See Also:
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 class javax.servlet.jsp.JspWriter
Parameters:
f - The float to be printed
Throws:
java.io.IOException - If an error occured while writing
See Also:
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 class javax.servlet.jsp.JspWriter
Parameters:
d - The double to be printed
Throws:
java.io.IOException - If an error occured while writing
See Also:
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 class javax.servlet.jsp.JspWriter
Parameters:
s - The array of chars to be printed
Throws:
java.lang.NullPointerException - If s is null
java.io.IOException - If an error occured while writing

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 class javax.servlet.jsp.JspWriter
Parameters:
s - The String to be printed
Throws:
java.io.IOException - If an error occured while writing

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 class javax.servlet.jsp.JspWriter
Parameters:
obj - The Object to be printed
Throws:
java.io.IOException - If an error occured while writing
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 class javax.servlet.jsp.JspWriter
Throws:
java.io.IOException - If an error occured while writing

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 class javax.servlet.jsp.JspWriter
Parameters:
x - the boolean to write
Throws:
java.io.IOException - If an error occured while writing

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 class javax.servlet.jsp.JspWriter
Parameters:
x - the char to write
Throws:
java.io.IOException - If an error occured while writing

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 class javax.servlet.jsp.JspWriter
Parameters:
x - the int to write
Throws:
java.io.IOException - If an error occured while writing

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 class javax.servlet.jsp.JspWriter
Parameters:
x - the long to write
Throws:
java.io.IOException - If an error occured while writing

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 class javax.servlet.jsp.JspWriter
Parameters:
x - the float to write
Throws:
java.io.IOException - If an error occured while writing

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 class javax.servlet.jsp.JspWriter
Parameters:
x - the double to write
Throws:
java.io.IOException - If an error occured while writing

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 class javax.servlet.jsp.JspWriter
Parameters:
x - the char[] to write
Throws:
java.io.IOException - If an error occured while writing

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 class javax.servlet.jsp.JspWriter
Parameters:
x - the String to write
Throws:
java.io.IOException - If an error occured while writing

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 class javax.servlet.jsp.JspWriter
Parameters:
x - the Object to write
Throws:
java.io.IOException - If an error occured while writing

Apache Tomcat 6.0.39

Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.