javax.faces.context
Class ResponseWriter

java.lang.Object
  java.io.Writer
      javax.faces.context.ResponseWriter

Direct Known Subclasses:

javax.faces.webapp.ResponseWriterBase

public abstract class ResponseWriter

extends java.io.Writer

ResponseWriter is an abstract class describing an adapter to an underlying output mechanism for character-based output. In addition to the low-level write() methods inherited from java.io>Writer, this class provides utility methods that are useful in producing elements and attributes for markup languages like HTML and XML.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

ResponseWriter()

Method Summary

abstract void	endDocument() Write whatever text should end a response.
abstract void	endElement(java.lang.String name) Write the end of an element, after closing any open element created by a call to startElement().
abstract void	startDocument() Write whatever text should begin a response.
abstract void	startElement(java.lang.String name) Write the start of an element, up to and including the element name.
abstract void	writeAttribute(java.lang.String name, java.lang.Object value) Write an attribute name and corresponding value (after converting that text to a String if necessary), after escaping it properly.
abstract void	writeComment(java.lang.Object comment) Write a comment containing the specified text, after converting that text to a String if necessary.
abstract void	writeText(char text) Write a single character, after escaping it properly.
abstract void	writeText(char[] text) Write text from a character array, after escaping it properly.
abstract void	writeText(char[] text, int off, int len) Write text from a character array, after escaping it properly for this method.
abstract void	writeText(java.lang.Object text) Write an object (after converting it to a String, if necessary), after escaping it properly.
abstract void	writeURIAttribute(java.lang.String name, java.lang.Object value) Write a URI attribute name and corresponding value (after converting that text to a String if necessary), after encoding it properly (for example, '%' encoded for HTML).

Methods inherited from class java.io.Writer

close, flush, write, write, write, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResponseWriter

public ResponseWriter()

Method Detail

startDocument

public abstract void startDocument()
                            throws java.io.IOException

Write whatever text should begin a response.

Throws:

java.io.IOException - if an input/output error occurs

endDocument

public abstract void endDocument()
                          throws java.io.IOException

Write whatever text should end a response. If there is an open element that has been created by a call to startElement(), that element will be closed first.

Throws:

java.io.IOException - if an input/output error occurs

startElement

public abstract void startElement(java.lang.String name)
                           throws java.io.IOException

Write the start of an element, up to and including the element name. Once this method has been called, clients can call writeAttribute() or writeURIAttribute() method to add attributes and corresponding values. The starting element will be closed (that is, the trailing '>' character added) on any subsequent call to startElement(), writeComment(), writeText(), endElement(), or endDocument().

Parameters:

name - Name of the element to be started

Throws:

java.io.IOException - if an input/output error occurs

java.lang.NullPointerException - if name is null

endElement

public abstract void endElement(java.lang.String name)
                         throws java.io.IOException

Write the end of an element, after closing any open element created by a call to startElement().

Parameters:

name - Name of the element to be ended

Throws:

java.io.IOException - if an input/output error occurs

java.lang.NullPointerException - if name is null

writeAttribute

public abstract void writeAttribute(java.lang.String name,
                                    java.lang.Object value)
                             throws java.io.IOException

Write an attribute name and corresponding value (after converting that text to a String if necessary), after escaping it properly. This method may only be called after a call to startElement(), and before the opened element has been closed.

Parameters:

name - Attribute name to be added

value - Attribute value to be added

Throws:

java.lang.IllegalStateException - if this method is called when there is no currently open element

java.io.IOException - if an input/output error occurs

java.lang.NullPointerException - if name or value is null

writeURIAttribute

public abstract void writeURIAttribute(java.lang.String name,
                                       java.lang.Object value)
                                throws java.io.IOException

Write a URI attribute name and corresponding value (after converting that text to a String if necessary), after encoding it properly (for example, '%' encoded for HTML). This method may only be called after a call to startElement(), and before the opened element has been closed.

Parameters:

name - Attribute name to be added

value - Attribute value to be added

Throws:

java.lang.IllegalStateException - if this method is called when there is no currently open element

java.io.IOException - if an input/output error occurs

java.lang.NullPointerException - if name or value is null

writeComment

public abstract void writeComment(java.lang.Object comment)
                           throws java.io.IOException

Write a comment containing the specified text, after converting that text to a String if necessary. If there is an open element that has been created by a call to startElement(), that element will be closed first.

Parameters:

comment - Text content of the comment

Throws:

java.io.IOException - if an input/output error occurs

java.lang.NullPointerException - if comment is null

writeText

public abstract void writeText(java.lang.Object text)
                        throws java.io.IOException

Write an object (after converting it to a String, if necessary), after escaping it properly. If there is an open element that has been created by a call to startElement(), that element will be closed first.

Parameters:

text - Text to be written

Throws:

java.io.IOException - if an input/output error occurs

java.lang.NullPointerException - if text is null

writeText

public abstract void writeText(char text)
                        throws java.io.IOException

Write a single character, after escaping it properly. If there is an open element that has been created by a call to startElement(), that element will be closed first.

Parameters:

text - Text to be written

Throws:

java.io.IOException - if an input/output error occurs

writeText

public abstract void writeText(char[] text)
                        throws java.io.IOException

Write text from a character array, after escaping it properly. This is equivalent to calling writeText(c, 0, c.length). If there is an open element that has been created by a call to startElement(), that element will be closed first.

Parameters:

text - Text to be written

Throws:

java.io.IOException - if an input/output error occurs

java.lang.NullPointerException - if text is null

writeText

public abstract void writeText(char[] text,
                               int off,
                               int len)
                        throws java.io.IOException

Write text from a character array, after escaping it properly for this method. If there is an open element that has been created by a call to startElement(), that element will be closed first.

Parameters:

text - Text to be written

off - Starting offset (zero-relative)

len - Number of characters to be written

Throws:

java.lang.IndexOutOfBoundsException - if the calculated starting or ending position is outside the bounds of the character array

java.io.IOException - if an input/output error occurs

java.lang.NullPointerException - if text is null