oracle.cabo.ui.io
Class XMLOutputMethod

java.lang.Object
  |
  +--oracle.cabo.ui.io.XMLOutputMethod

All Implemented Interfaces:

CloneWithPrintWriter, OutputMethod

public class XMLOutputMethod

extends java.lang.Object

implements OutputMethod, CloneWithPrintWriter

Implementation of OutputMethod for outputting XHTML.

Constructor Summary

XMLOutputMethod(java.io.PrintWriter out)
Creates an XMLOutputMethod.

XMLOutputMethod(java.io.PrintWriter out, java.lang.String encoding)
Creates an XMLOutputMethod.

Method Summary

OutputMethod	cloneWithPrintWriter(java.io.PrintWriter writer) Creates a new instance of this OutputMethod, using a different PritnWriter.
void	endDocument() Outputs whatever text should end a document.
void	endElement(java.lang.String name) Outputs text for the end of an element.
void	flush() Flushes any ouput buffered by the output method to the underlying PrintWriter or OutputStream.
java.lang.String	getContentType() Returns the MIME content type for this output method.
java.lang.String	getEncoding() Returns the encoding specified for this HTMLOutputMethod
protected java.io.PrintWriter	getPrintWriter() Returns the PrintWriter to write to.
void	startDocument() Outputs the start of a document.
void	startElement(java.lang.String name) Outputs the text for the start of an element.
boolean	supportsCloneWithPrintWriter() Returns true if the OutputMethod supports cloning the OutputMethod with a different PrintWriter
void	writeAttribute(java.lang.String name, java.lang.Object value) Writes an attribute with the given name and value.
void	writeAttribute(java.lang.String name, java.lang.String value, java.lang.String value2) Writes an attribute with the given name and two string values.
void	writeComment(java.lang.String text) Writes a comment.
void	writeRawText(char text) Writes a character, without performing any escaping.
void	writeRawText(char[] text, int start, int length) Writes a character array, without performing any escaping.
void	writeRawText(java.lang.String text) Writes a string, without performing any escaping.
void	writeText(char text) Writes a character, escaped properly for this method.
void	writeText(char[] text, int start, int length) Writes a character array, escaped properly for this method.
void	writeText(java.lang.Object text) Writes an Object, escaped properly for this method.
void	writeText(java.lang.String text) Writes a String, escaped properly for this method.
void	writeURIAttribute(java.lang.String name, java.lang.Object value) Writes a URI attribute with the given name and value, based on It is an error to call this method if the previous call to the output method was not either startElement() or another writeAttribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLOutputMethod

public XMLOutputMethod(java.io.PrintWriter out)

Creates an XMLOutputMethod.

Parameters:

out - a PrintWriter to write to

XMLOutputMethod

public XMLOutputMethod(java.io.PrintWriter out,
                       java.lang.String encoding)
                throws java.io.UnsupportedEncodingException

Creates an XMLOutputMethod.

Parameters:

out - a PrintWriter to write to

encoding - the character encoding the PrintWriter uses

Method Detail

supportsCloneWithPrintWriter

public boolean supportsCloneWithPrintWriter()

Returns true if the OutputMethod supports cloning the OutputMethod with a different PrintWriter

Specified by:

supportsCloneWithPrintWriter in interface CloneWithPrintWriter

cloneWithPrintWriter

public OutputMethod cloneWithPrintWriter(java.io.PrintWriter writer)

Creates a new instance of this OutputMethod, using a different PritnWriter.

Specified by:

cloneWithPrintWriter in interface CloneWithPrintWriter

getContentType

public java.lang.String getContentType()

Returns the MIME content type for this output method.

Specified by:

getContentType in interface OutputMethod

getEncoding

public java.lang.String getEncoding()

Returns the encoding specified for this HTMLOutputMethod

startDocument

public void startDocument()
                   throws java.io.IOException

Outputs the start of a document. For XML, this is the xml tag with the version and encoding information

Specified by:

startDocument in interface OutputMethod

endDocument

public void endDocument()
                 throws java.io.IOException

Description copied from interface: OutputMethod

Outputs whatever text should end a document.

Specified by:

endDocument in interface OutputMethod

flush

public void flush()
           throws java.io.IOException

Flushes any ouput buffered by the output method to the underlying PrintWriter or OutputStream.

Specified by:

flush in interface OutputMethod

writeComment

public void writeComment(java.lang.String text)
                  throws java.io.IOException

Writes a comment.

Specified by:

writeComment in interface OutputMethod

writeText

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

Writes a String, escaped properly for this method.

Specified by:

writeText in interface OutputMethod

writeText

public void writeText(char[] text,
                      int start,
                      int length)
               throws java.io.IOException

Writes a character array, escaped properly for this method.

Specified by:

writeText in interface OutputMethod

writeText

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

Writes an Object, escaped properly for this method.

Specified by:

writeText in interface OutputMethod

writeText

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

Writes a character, escaped properly for this method.

Specified by:

writeText in interface OutputMethod

writeRawText

public void writeRawText(java.lang.String text)
                  throws java.io.IOException

Writes a string, without performing any escaping.

Specified by:

writeRawText in interface OutputMethod

writeRawText

public void writeRawText(char[] text,
                         int start,
                         int length)
                  throws java.io.IOException

Writes a character array, without performing any escaping.

Specified by:

writeRawText in interface OutputMethod

writeRawText

public void writeRawText(char text)
                  throws java.io.IOException

Writes a character, without performing any escaping.

Specified by:

writeRawText in interface OutputMethod

startElement

public void startElement(java.lang.String name)

Outputs the text for the start of an element.

Specified by:

startElement in interface OutputMethod

endElement

public void endElement(java.lang.String name)

Outputs text for the end of an element.

Specified by:

endElement in interface OutputMethod

writeAttribute

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

Description copied from interface: OutputMethod

Writes an attribute with the given name and two string values. It is an error to call this method if the previous call to the output method was not either startElement() or another writeAttribute.

Specified by:

writeAttribute in interface OutputMethod

writeAttribute

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

Description copied from interface: OutputMethod

Writes an attribute with the given name and value. It is an error to call this method if the previous call to the output method was not either startElement() or another writeAttribute.

Specified by:

writeAttribute in interface OutputMethod

writeURIAttribute

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

Description copied from interface: OutputMethod

Writes a URI attribute with the given name and value, based on It is an error to call this method if the previous call to the output method was not either startElement() or another writeAttribute.

Specified by:

writeURIAttribute in interface OutputMethod

getPrintWriter

protected final java.io.PrintWriter getPrintWriter()

Returns the PrintWriter to write to.