org.htmlcleaner

Class SpecialEntity

java.lang.Object

org.htmlcleaner.SpecialEntity

public class SpecialEntity
extends Object

This class contains map with special entities used in HTML and their unicodes.

Method Summary

Modifier and Type	Method and Description
static void	addEntity(String entityName, int intCode) Add new entity to the set.
char	getCharacter()
String	getDecimalNCR()
static SpecialEntity	getEntity(String key)
String	getEscapedValue()
String	getHexNCR()
int	getIntCode()
String	getKey()

Methods inherited from class java.lang.Object

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

Method Detail

addEntity

public static void addEntity(String entityName,
                             int intCode)
                      throws HtmlCleanerException

Add new entity to the set.

Parameters:

entityName - Entity name, for example "pound"

intCode - Unicode of the entity, for example 163

Throws:

HtmlCleanerException

getEntity

public static SpecialEntity getEntity(String key)

getKey

public String getKey()

getIntCode

public int getIntCode()

getCharacter

public char getCharacter()

getDecimalNCR

public String getDecimalNCR()

Returns:

Numeric Character Reference in decimal format

getHexNCR

public String getHexNCR()

Returns:

Numeric Character Reference in hex format

getEscapedValue

public String getEscapedValue()

Returns:

Escaped value of the entity