com.topologi.diffx.xml.esc
Class XMLEscapeWriterUTF8

java.lang.Object
  com.topologi.diffx.xml.esc.XMLEscapeWriterBase
      com.topologi.diffx.xml.esc.XMLEscapeWriterUTF8

All Implemented Interfaces:

XMLEscapeWriter

public final class XMLEscapeWriterUTF8

extends com.topologi.diffx.xml.esc.XMLEscapeWriterBase

implements XMLEscapeWriter

A utility class for escaping XML data using the UTF-8 encoding.

Version:

7 March 2005

Author:

Christophe Lauret

Constructor Summary

XMLEscapeWriterUTF8(Writer w)
Creates a new XML escape writer using the utf-8 encoding.

Method Summary

String	getEncoding() Returns the encoding for this writer.
void	writeAttValue(char[] ch, int off, int len) Replaces '<', '&', '"' and '\'' as well an any character that is not part of the standard unicode range.
void	writeAttValue(String value) Default implementation calling the XMLEscapeWriter.writeAttValue(char[], int, int).
void	writeText(char c) Replace characters which are invalid in element values, by the corresponding entity in a given String.
void	writeText(char[] ch, int off, int len) Replace characters which are invalid in element values, by the corresponding entity.
void	writeText(String value) Default implementation calling the XMLEscapeWriter.writeAttValue(char[], int, int).

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.topologi.diffx.xml.esc.XMLEscapeWriter

getEncoding, writeAttValue, writeText, writeText

Constructor Detail

XMLEscapeWriterUTF8

public XMLEscapeWriterUTF8(Writer w)
                    throws NullPointerException

Creates a new XML escape writer using the utf-8 encoding.

Parameters:

w - The writer to wrap.

Throws:

NullPointerException - if the writer is null.

Method Detail

writeAttValue

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

Replaces '<', '&', '"' and '\'' as well an any character that is not part of the standard unicode range.

 Char ::= #x9 | #xA | #xD |
          [#x20-#xD7FF] |
          [#xE000-#xFFFD] |
          [#x10000-#x10FFFF]
 

Specified by:

writeAttValue in interface XMLEscapeWriter

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.

See Also:

XMLEscapeWriter.writeAttValue(char[], int, int)

writeText

public void writeText(char c)
               throws IOException

Replace characters which are invalid in element values, by the corresponding entity in a given String.

these characters are:

• '&' by the ampersand entity "&amp"
• '<' by the entity "&lt;"

Note: this function assumes that there are no entities in the given String. If there are existing entities, then the ampersand character will be escaped by the ampersand entity.

Specified by:

writeText in interface XMLEscapeWriter

Parameters:

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

Throws:

IOException - If thrown by the underlying writer.

See Also:

XMLEscapeWriter.writeText(char)

writeAttValue

public final void writeAttValue(String value)
                         throws IOException

Default implementation calling the XMLEscapeWriter.writeAttValue(char[], int, int).

Specified by:

writeAttValue in interface XMLEscapeWriter

Parameters:

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

Throws:

IOException - If thrown by the underlying writer.

See Also:

XMLEscapeWriter.writeAttValue(String)

writeText

public final void writeText(String value)
                     throws IOException

Default implementation calling the XMLEscapeWriter.writeAttValue(char[], int, int).

Specified by:

writeText in interface XMLEscapeWriter

Parameters:

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

Throws:

IOException - If thrown by the underlying writer.

See Also:

XMLEscapeWriter.writeAttValue(String)

writeText

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

Replace characters which are invalid in element values, by the corresponding entity.

This method calls XMLEscapeWriter.writeText(char) for each character.

Specified by:

writeText in interface XMLEscapeWriter

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.

See Also:

XMLEscapeWriter.writeText(char[], int, int)

getEncoding

public final String getEncoding()

Returns the encoding for this writer.

Specified by:

getEncoding in interface XMLEscapeWriter

Returns:

The encoding used by the implementing class.

See Also:

XMLEscapeWriter.getEncoding()