org.apache.jasper.runtime
Class BodyContentImpl

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

public class BodyContentImpl
extends javax.servlet.jsp.tagext.BodyContent

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.

Author:
Brian Remmington

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
BodyContentImpl(javax.servlet.jsp.JspWriter enclosingWriter)
          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.
 int getBufferSize()
          This method returns the size of the buffer used by the JspWriter.
 java.io.Reader getReader()
          Return the value of this BodyContent as a Reader.
 int getRemaining()
          This method returns the number of unused bytes in the buffer.
 java.lang.String getString()
          Return the value of the BodyContent as a String.
 void newLine()
          Write a line separator.
 void print(boolean flag)
          Print a boolean value.
 void print(char c)
          Print a character.
 void print(char[] ac)
          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 flag)
          Print a boolean value and then terminate the line.
 void println(char c)
          Print a character and then terminate the line.
 void println(char[] ac)
          Print an array of characters and then terminate the line.
 void println(double d)
          Print a double-precision floating-point number and then terminate the line.
 void println(float f)
          Print a floating-point number and then terminate the line.
 void println(int i)
          Print an integer and then terminate the line.
 void println(long l)
          Print a long integer and then terminate the line.
 void println(java.lang.Object obj)
          Print an Object and then terminate the line.
 void println(java.lang.String s)
          Print a String and then terminate the line.
 void write(char[] ac)
           
 void write(char[] ac, int i, int j)
           
 void write(int i)
           
 void write(java.lang.String s)
           
 void write(java.lang.String s, int i, int j)
           
 void writeOut(java.io.Writer writer)
          Write the contents of this BodyContent into a Writer.
 
Methods inherited from class javax.servlet.jsp.tagext.BodyContent
clearBody, flush, getEnclosingWriter
 
Methods inherited from class javax.servlet.jsp.JspWriter
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

BodyContentImpl

public BodyContentImpl(javax.servlet.jsp.JspWriter enclosingWriter)
Constructor.

Method Detail

write

public void write(int i)
           throws java.io.IOException
Overrides:
write in class java.io.Writer
Throws:
java.io.IOException

write

public void write(char[] ac,
                  int i,
                  int j)
           throws java.io.IOException
Specified by:
write in class java.io.Writer
Throws:
java.io.IOException

write

public void write(char[] ac)
           throws java.io.IOException
Overrides:
write in class java.io.Writer
Throws:
java.io.IOException

write

public void write(java.lang.String s,
                  int i,
                  int j)
           throws java.io.IOException
Overrides:
write in class java.io.Writer
Throws:
java.io.IOException

write

public void write(java.lang.String s)
           throws java.io.IOException
Overrides:
write in class java.io.Writer
Throws:
java.io.IOException

newLine

public void newLine()
             throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
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 flag)
           throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
Print a boolean value. The string produced by String.valueOf(boolean) is written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.

Specified by:
print in class javax.servlet.jsp.JspWriter
Parameters:
flag - 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
Description copied from class: javax.servlet.jsp.JspWriter
Print a character. The character is written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.

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
Description copied from class: javax.servlet.jsp.JspWriter
Print an integer. The string produced by String.valueOf(int) is written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.

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
Description copied from class: javax.servlet.jsp.JspWriter
Print a long integer. The string produced by String.valueOf(long) is written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.

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
Description copied from class: javax.servlet.jsp.JspWriter
Print a floating-point number. The string produced by String.valueOf(float) is written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.

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
Description copied from class: javax.servlet.jsp.JspWriter
Print a double-precision floating-point number. The string produced by String.valueOf(double) is written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.

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[] ac)
           throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
Print an array of characters. The characters are written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.

Specified by:
print in class javax.servlet.jsp.JspWriter
Parameters:
ac - The array of chars to be printed
Throws:
java.io.IOException - If an error occured while writing

print

public void print(java.lang.String s)
           throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
Print a string. If the argument is null then the string "null" is printed. Otherwise, the string's characters are written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.

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
Description copied from class: javax.servlet.jsp.JspWriter
Print an object. The string produced by the String.valueOf(Object) method is written to the JspWriter's buffer or, if no buffer is used, directly to the underlying writer.

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
Description copied from class: javax.servlet.jsp.JspWriter
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').

Specified by:
println in class javax.servlet.jsp.JspWriter
Throws:
java.io.IOException - If an error occured while writing

println

public void println(boolean flag)
             throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
Print a boolean value and then terminate the line. This method behaves as though it invokes JspWriter.print(boolean) and then JspWriter.println().

Specified by:
println in class javax.servlet.jsp.JspWriter
Parameters:
flag - the boolean to write
Throws:
java.io.IOException - If an error occured while writing

println

public void println(char c)
             throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
Print a character and then terminate the line. This method behaves as though it invokes JspWriter.print(char) and then JspWriter.println().

Specified by:
println in class javax.servlet.jsp.JspWriter
Parameters:
c - the char to write
Throws:
java.io.IOException - If an error occured while writing

println

public void println(int i)
             throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
Print an integer and then terminate the line. This method behaves as though it invokes JspWriter.print(int) and then JspWriter.println().

Specified by:
println in class javax.servlet.jsp.JspWriter
Parameters:
i - the int to write
Throws:
java.io.IOException - If an error occured while writing

println

public void println(long l)
             throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
Print a long integer and then terminate the line. This method behaves as though it invokes JspWriter.print(long) and then JspWriter.println().

Specified by:
println in class javax.servlet.jsp.JspWriter
Parameters:
l - the long to write
Throws:
java.io.IOException - If an error occured while writing

println

public void println(float f)
             throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
Print a floating-point number and then terminate the line. This method behaves as though it invokes JspWriter.print(float) and then JspWriter.println().

Specified by:
println in class javax.servlet.jsp.JspWriter
Parameters:
f - the float to write
Throws:
java.io.IOException - If an error occured while writing

println

public void println(double d)
             throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
Print a double-precision floating-point number and then terminate the line. This method behaves as though it invokes JspWriter.print(double) and then JspWriter.println().

Specified by:
println in class javax.servlet.jsp.JspWriter
Parameters:
d - the double to write
Throws:
java.io.IOException - If an error occured while writing

println

public void println(char[] ac)
             throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
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:
ac - the char[] to write
Throws:
java.io.IOException - If an error occured while writing

println

public void println(java.lang.String s)
             throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
Print a String and then terminate the line. This method behaves as though it invokes JspWriter.print(String) and then JspWriter.println().

Specified by:
println in class javax.servlet.jsp.JspWriter
Parameters:
s - the String to write
Throws:
java.io.IOException - If an error occured while writing

println

public void println(java.lang.Object obj)
             throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
Print an Object and then terminate the line. This method behaves as though it invokes JspWriter.print(Object) and then JspWriter.println().

Specified by:
println in class javax.servlet.jsp.JspWriter
Parameters:
obj - the Object to write
Throws:
java.io.IOException - If an error occured while writing

clear

public void clear()
           throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
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.

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

close

public void close()
           throws java.io.IOException
Description copied from class: javax.servlet.jsp.JspWriter
Close the stream, flushing it first.

This method needs not be invoked explicitly for the initial JspWriter as the code generated by the JSP container will automatically include a call to close().

Closing a previously-closed stream, unlike flush(), has no effect.

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

getReader

public java.io.Reader getReader()
Description copied from class: javax.servlet.jsp.tagext.BodyContent
Return the value of this BodyContent as a Reader.

Specified by:
getReader in class javax.servlet.jsp.tagext.BodyContent
Returns:
the value of this BodyContent as a Reader

getString

public java.lang.String getString()
Description copied from class: javax.servlet.jsp.tagext.BodyContent
Return the value of the BodyContent as a String.

Specified by:
getString in class javax.servlet.jsp.tagext.BodyContent
Returns:
the value of the BodyContent as a String

writeOut

public void writeOut(java.io.Writer writer)
              throws java.io.IOException
Description copied from class: javax.servlet.jsp.tagext.BodyContent
Write the contents of this BodyContent into a Writer. Subclasses may optimize common invocation patterns.

Specified by:
writeOut in class javax.servlet.jsp.tagext.BodyContent
Parameters:
writer - The writer into which to place the contents of this body evaluation
Throws:
java.io.IOException - if an I/O error occurred while writing the contents of this BodyContent to the given Writer

getBufferSize

public int getBufferSize()
Description copied from class: javax.servlet.jsp.JspWriter
This method returns the size of the buffer used by the JspWriter.

Overrides:
getBufferSize in class javax.servlet.jsp.JspWriter
Returns:
the size of the buffer in bytes, or 0 is unbuffered.


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