oracle.cabo.ui.io
Interface OutputMethod

All Known Implementing Classes:

PlainOutputMethod, WrappingOutputMethod, XMLOutputMethod, NullOutputMethod, HTMLOutputMethod

public interface OutputMethod

Abstraction for outputting text in a tag language.

Method Summary

void	endDocument() Outputs whatever text should end a document.
void	endElement(java.lang.String name) Outputs an end element tag.
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.
void	startDocument() Outputs whatever text should begin a document.
void	startElement(java.lang.String name) Outputs a start element tag.
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.

Method Detail

getContentType

public java.lang.String getContentType()

Returns the MIME content type for this output method.

startDocument

public void startDocument()
                   throws java.io.IOException

Outputs whatever text should begin a document.

endDocument

public void endDocument()
                 throws java.io.IOException

Outputs whatever text should end a document.

flush

public void flush()
           throws java.io.IOException

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

writeComment

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

Writes a comment.

writeText

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

Writes a String, escaped properly for this method.

writeText

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

Writes an Object, escaped properly for this method.

writeText

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

Writes a character array, escaped properly for this method.

writeText

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

Writes a character, escaped properly for this method.

writeRawText

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

Writes a string, without performing any escaping.

writeRawText

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

Writes a character array, without performing any escaping.

writeRawText

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

Writes a character, without performing any escaping.

startElement

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

Outputs a start element tag. Once this method has been alled, clients can begin calling writeAttribute().

endElement

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

Outputs an end element tag. This should be called once all the contents of the element have been renderered - it is not used to close the start-element-tag.

writeAttribute

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

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.

writeAttribute

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

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.

writeURIAttribute

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

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.