org.exoplatform.commons.utils

Class HTMLEntityEncoder

java.lang.Object

org.gatein.common.text.AbstractCharEncoder

org.gatein.common.text.EntityEncoder

org.exoplatform.commons.utils.HTMLEntityEncoder

All Implemented Interfaces:

org.gatein.common.text.CharEncoder

public class HTMLEntityEncoder
extends org.gatein.common.text.EntityEncoder

This encoder provides a few methods to encode the String to its HTML entity representation.

Version:

$Revision$

Author:

Trong Tran

Field Summary

Fields inherited from class org.gatein.common.text.EntityEncoder

BASIC, FULL

Constructor Summary

Constructors

Constructor and Description
HTMLEntityEncoder()

Method Summary

Modifier and Type	Method and Description
String	encodeHTML(String input) Encode data for use in HTML
String	encodeHTMLAttribute(String input) Encode data for use in HTML attributes.
static HTMLEntityEncoder	getInstance()
String	lookupEntityName(char c)
String	lookupHexEntityNumber(char c)
void	safeEncode(char[] chars, int off, int len, org.gatein.common.text.CharWriter writer)

Methods inherited from class org.gatein.common.text.EntityEncoder

encode, lookup, put, remove, reverse

Methods inherited from class org.gatein.common.text.AbstractCharEncoder

encode, encode, encode, encode

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLEntityEncoder

public HTMLEntityEncoder()

Method Detail

getInstance

public static HTMLEntityEncoder getInstance()

encodeHTML

public String encodeHTML(String input)

Encode data for use in HTML

Parameters:

input - the string to encode for HTML

Returns:

input encoded for HTML

encodeHTMLAttribute

public String encodeHTMLAttribute(String input)

Encode data for use in HTML attributes.

Parameters:

input - the string to encode for a HTML attribute

Returns:

input encoded for use as value of a HTML attribute

safeEncode

public void safeEncode(char[] chars,
                       int off,
                       int len,
                       org.gatein.common.text.CharWriter writer)
                throws org.gatein.common.text.EncodingException

Overrides:

safeEncode in class org.gatein.common.text.EntityEncoder

Throws:

org.gatein.common.text.EncodingException

lookupEntityName

public final String lookupEntityName(char c)

lookupHexEntityNumber

public final String lookupHexEntityNumber(char c)