org.apache.tapestry.util.text
Class MarkupCharacterTranslator

java.lang.Object
  org.apache.tapestry.util.text.MarkupCharacterTranslator

All Implemented Interfaces:

ICharacterTranslator

Direct Known Subclasses:

XmlCharacterTranslator

public class MarkupCharacterTranslator
extends Object
implements ICharacterTranslator

An object that encodes a character according to rules of the HTML specification, so that it will be properly parsed by a browser irrespectively of the character encoding used in the HTML output.

Since:

4.0

Author:

mb

Constructor Summary

MarkupCharacterTranslator()

MarkupCharacterTranslator(boolean encodeNonAscii)

MarkupCharacterTranslator(boolean encodeNonAscii, ICharacterMatcher safeMatcher, ICharacterTranslator entityTranslator)

MarkupCharacterTranslator(boolean encodeNonAscii, String safeCharacters, String[][] entities)

Method Summary

String

translate(char ch) Translates the provided character into a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkupCharacterTranslator

public MarkupCharacterTranslator()

MarkupCharacterTranslator

public MarkupCharacterTranslator(boolean encodeNonAscii)

MarkupCharacterTranslator

public MarkupCharacterTranslator(boolean encodeNonAscii,
                                 ICharacterMatcher safeMatcher,
                                 ICharacterTranslator entityTranslator)

MarkupCharacterTranslator

public MarkupCharacterTranslator(boolean encodeNonAscii,
                                 String safeCharacters,
                                 String[][] entities)

Method Detail

translate

public String translate(char ch)

Description copied from interface: ICharacterTranslator

Translates the provided character into a string.

Specified by:

translate in interface ICharacterTranslator

Parameters:

ch - the character to be translated

Returns:

null if the character is not to be translated, an empty string if the character is to be ignored, or another string to represent the character translation

See Also:

ICharacterTranslator.translate(char)