Package com.topologi.diffx.xml.esc

Class XMLEscapeBase

java.lang.Object

com.topologi.diffx.xml.esc.XMLEscapeBase

All Implemented Interfaces:

XMLEscape

Direct Known Subclasses:

XMLEscapeASCII, XMLEscapeUTF8

abstract class XMLEscapeBase
extends Object
implements XMLEscape

A base implementation for the XML escape classes.

Version:

3 September 2004

Field Summary

Fields

Modifier and Type	Field	Description
private final String	encoding	The encoding for the implementation.

Constructor Summary

Constructors

Constructor	Description
XMLEscapeBase(String encoding)	Creates a new XML Escape.

Method Summary

Modifier and Type	Method	Description
final String	getEncoding()	Returns the encoding used.
final String	toAttributeValue(String value)	Default implementation calling the XMLEscape.toAttributeValue(char[], int, int).
final String	toElementText(String value)	Default implementation calling the XMLEscape.toAttributeValue(char[], int, int).

Methods inherited from class java.lang.Object

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

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

toAttributeValue, toElementText

Field Details

encoding

private final String encoding

The encoding for the implementation.

Constructor Details

XMLEscapeBase

XMLEscapeBase(String encoding)

Creates a new XML Escape.

Parameters:

encoding - The encoding used.

Method Details

toAttributeValue

public final String toAttributeValue(String value)

Default implementation calling the XMLEscape.toAttributeValue(char[], int, int). Returns a well-formed attribute value.

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

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

Specified by:

toAttributeValue in interface XMLEscape

Parameters:

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

Returns:

A well-formed value for the attribute.

toElementText

public final String toElementText(String value)

Default implementation calling the XMLEscape.toAttributeValue(char[], int, int). Returns a well-formed text value for the element.

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

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

Specified by:

toElementText in interface XMLEscape

Parameters:

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

Returns:

A well-formed value for the text node.

getEncoding

public final String getEncoding()

Returns the encoding used. Returns the encoding used by the implementing class.

Specified by:

getEncoding in interface XMLEscape

Returns:

The encoding used by the implementing class.