com.topologi.diffx.xml.esc

Interface XMLEscapeWriter

All Known Implementing Classes:

XMLEscapeWriterASCII, XMLEscapeWriterUTF8

public interface XMLEscapeWriter

An interface to escape XML character data onto a writer.

This interface mimics the XMLEscape interface but is designed to be more efficient for writers, in other words, it wraps a writer and writes directly onto it.

This interface is based on the paragraph 2.4 of the XML 1.0 Specifications.

Version:

7 March 2005

Author:

Christophe Lauret

Method Summary

Modifier and Type	Method and Description
String	getEncoding() Returns the encoding used by the implementing class.
void	writeAttValue(char[] ch, int off, int len) Writes a well-formed attribute value.
void	writeAttValue(String value) Writes a well-formed attribute value.
void	writeText(char c) Writes the character so that the text value for the element remains well-formed.
void	writeText(char[] ch, int off, int len) Writes a well-formed text value for the element.
void	writeText(String text) Writes the text string so that the text value for the element remains well-formed.

Method Detail

writeAttValue

void writeAttValue(char[] ch,
                   int off,
                   int len)
            throws IOException

Writes a well-formed attribute value.

This method must replace any character in the specified value by the corresponding numeric character reference or the predefined XML general entities, if the character is not allowed or not in the encoding range.

Attribute values must not contain '&' or '<. Quotes and apostrophes must also be escaped by "&quot;" and "&apos;" respectively.

Parameters:

ch - The value that needs to be attribute-escaped.

off - The start (offset) of the characters.

len - The length of characters to.

Throws:

IOException - If thrown by the underlying writer.

writeAttValue

void writeAttValue(String value)
            throws IOException

Writes a well-formed attribute value.

Method provided for convenience, using the same specifications as writeAttValue(char[], int, int).

This method should return null if the given value is null.

Parameters:

value - The value that needs to be attribute-escaped.

Throws:

IOException - If thrown by the underlying writer.

writeText

void writeText(char[] ch,
               int off,
               int len)
        throws IOException

Writes a well-formed text value for the element.

This method must replace any character in the specified value by the corresponding numeric character reference or the predefined XML general entities, if the character is not allowed or not in the encoding range.

The text of an element must not contain '&' or '<.

Parameters:

ch - The value that needs to be attribute-escaped.

off - The start (offset) of the characters.

len - The length of characters to.

Throws:

IOException - If thrown by the underlying writer.

writeText

void writeText(String text)
        throws IOException

Writes the text string so that the text value for the element remains well-formed.

Method provided for convenience, using the same specifications as writeText(char[], int, int).

This method should do nothing if the given value is null.

Parameters:

text - The text that needs to be text-escaped.

Throws:

IOException - If thrown by the underlying writer.

writeText

void writeText(char c)
        throws IOException

Writes the character so that the text value for the element remains well-formed.

This method should return null if the given value is null.

Parameters:

c - The character that needs to be text-escaped.

Throws:

IOException - If thrown by the underlying writer.

getEncoding

String getEncoding()

Returns the encoding used by the implementing class.

Returns:

The encoding used by the implementing class.