org.apache.jasper.runtime

Class BodyContentImpl


public class BodyContentImpl
extends 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.
Authors:
Rajiv Mordani
Jan Luehe

Constructor Summary

BodyContentImpl(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.
Reader
getReader()
Return the value of this BodyJspWriter as a Reader.
int
getRemaining()
String
getString()
Return the value of the BodyJspWriter as a String.
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(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
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(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
writeOut(Writer out)
Write the contents of this BodyJspWriter into a Writer.

Constructor Details

BodyContentImpl

public BodyContentImpl(JspWriter enclosingWriter)
Constructor.

Method Details

clear

public void clear()
            throws IOException
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.

clearBuffer

public void clearBuffer()
            throws IOException
Clears the current contents of the buffer. Unlike clear(), this mehtod will not throw an IOException if the buffer has already been flushed. It merely clears the current content of the buffer and returns.

close

public void close()
            throws IOException
Close the stream, flushing it first. Once a stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously-closed stream, however, has no effect.

getReader

public Reader getReader()
Return the value of this BodyJspWriter as a Reader. Note: this is after evaluation!! There are no scriptlets, etc in this stream.
Returns:
the value of this BodyJspWriter as a Reader

getRemaining

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

getString

public String getString()
Return the value of the BodyJspWriter as a String. Note: this is after evaluation!! There are no scriptlets, etc in this stream.
Returns:
the value of the BodyJspWriter as a String

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(char[] s)
            throws IOException
Parameters:
s - The array of chars 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

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

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

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.

Parameters:
cbuf - A character array
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.

writeOut

public void writeOut(Writer out)
            throws IOException
Write the contents of this BodyJspWriter into a Writer. Subclasses are likely to do interesting things with the implementation so some things are extra efficient.
Parameters:
out - The writer into which to place the contents of this body evaluation

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