|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines an object that can write markup (XML, HTML, XHTML) style output.
A IResponseWriter
handles translation from unicode to
the markup language (escaping characters such as '<' and '>' to
their entity equivalents, '<' and '>') as well as assisting
with nested elements, closing tags, etc.
Method Summary | |
void |
attribute(java.lang.String name)
Simply prints the attribute name. |
void |
attribute(java.lang.String name,
int value)
Writes an integer attribute into the currently open tag. |
void |
attribute(java.lang.String name,
java.lang.String value)
Writes an attribute into the most recently opened tag. |
void |
begin(java.lang.String name)
Closes any existing tag then starts a new element. |
void |
beginEmpty(java.lang.String name)
Starts an element that will not later be matched with an end()
call. |
boolean |
checkError()
Invokes checkError() on the PrintWriter used to
format output. |
void |
close()
Closes this IResponseWriter . |
void |
closeTag()
Closes the most recently opened element by writing the '>' that ends it. |
void |
comment(java.lang.String value)
Writes an XML/HTML comment. |
void |
end()
Ends the element most recently started by begin(String) . |
void |
end(java.lang.String name)
Ends the most recently started element with the given name. |
void |
flush()
Forwards flush() to this
IResponseWriter 's PrintWriter . |
java.lang.String |
getContentType()
Returns the type of content generated by this response writer, as a MIME type. |
IResponseWriter |
getNestedWriter()
Returns a nested writer, one that accumulates its changes in a buffer. |
void |
print(char value)
Prints a single character, or its equivalent entity. |
void |
print(char[] data,
int offset,
int length)
The primary print() method, used by most other
methods. |
void |
print(int value)
Prints an integer. |
void |
print(java.lang.String value)
Invokes print(char[], int, int) to print the string. |
void |
println()
Closes the open tag (if any), then prints a line seperator to the output stream. |
void |
printRaw(char[] buffer,
int offset,
int length)
Prints a portion of an output buffer to the stream. |
void |
printRaw(java.lang.String value)
Prints output to the stream. |
Method Detail |
public void attribute(java.lang.String name)
java.lang.IllegalStateException
- if there is no open tag.public void attribute(java.lang.String name, int value)
java.lang.IllegalStateException
- if there is no open tag.public void attribute(java.lang.String name, java.lang.String value)
begin(String)
and before any other kind of writing (which closes the tag).
The value may be null, in which case this method behaves the same as
attribute(String)
.
java.lang.IllegalStateException
- if there is no open tag.public void begin(java.lang.String name)
public void beginEmpty(java.lang.String name)
end()
call. This is useful for elements that
do not need closing tags.public boolean checkError()
PrintWriter
used to
format output.public void close()
IResponseWriter
. Close tags are
written for any active elements. The PrintWriter
is then sent close()
. A nested writer will commit
its buffer to its containing writer.public void closeTag()
attribute()
methods
may not be used until a new element is opened with begin(String)
or
or beginEmpty(String)
.public void comment(java.lang.String value)
<!--
and -->
, and
provides a blank line after the close of the comment.
Most characters are valid inside a comment, so no check
of the contents is made (much like printRaw(String)
.
public void end()
begin(String)
. * The name of the tag * is popped off of the
active element stack and used to form an HTML close tag.public void end(java.lang.String name)
public void flush()
flush()
to this
IResponseWriter
's PrintWriter
.public IResponseWriter getNestedWriter()
IResponseWriter
.public void print(char[] data, int offset, int length)
print()
method, used by most other
methods.
Prints the character array, first closing any open tag. Problematic characters ('<', '>' and '&') are converted to appropriate entities.
Does nothing if data
is null.
Closes any open tag.
public void print(char value)
Closes any open tag.
public void print(int value)
Closes any open tag.
public void print(java.lang.String value)
print(char[], int, int)
to print the string. Use
printRaw(String)
if the character data is known to be safe.
Does nothing if value
is null.
Closes any open tag.
print(char[], int, int)
public void println()
public void printRaw(char[] buffer, int offset, int length)
print()
.
Does nothing if buffer
is null.
Closes any open tag.
public void printRaw(java.lang.String value)
print()
.
Does nothing if value
is null.
Closes any open tag.
public java.lang.String getContentType()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |