org.htmlparser.util

Class CharacterReference

public class CharacterReference extends Object implements Serializable, Cloneable, Ordered

Structure to hold a character and it's equivalent entity reference kernel. For the character reference © the character would be '©' and the kernel would be "copy", for example.

Character references are described at http://www.w3.org/TR/REC-html40/charset.html#entities Supports the Ordered interface so it's easy to create a list sorted by kernel, to perform binary searches on.

Field Summary
protected intmCharacter
The character value as an integer.
protected StringmKernel
This entity reference kernel.
Constructor Summary
CharacterReference(String kernel, int character)
Construct a CharacterReference with the character and kernel given.
Method Summary
intcompare(Object that)
Compare one reference to another.
intgetCharacter()
Get the character needing translation.
StringgetKernel()
Get this CharacterReference's kernel.
StringtoString()
Visualize this character reference as a string.

Field Detail

mCharacter

protected int mCharacter
The character value as an integer.

mKernel

protected String mKernel
This entity reference kernel. The text between the ampersand and the semicolon.

Constructor Detail

CharacterReference

public CharacterReference(String kernel, int character)
Construct a CharacterReference with the character and kernel given.

Parameters: kernel The kernel in the equivalent character entity reference. character The character needing encoding.

Method Detail

compare

public int compare(Object that)
Compare one reference to another.

See Also: Ordered

getCharacter

public int getCharacter()
Get the character needing translation.

Returns: The character.

getKernel

public String getKernel()
Get this CharacterReference's kernel.

Returns: The kernel in the equivalent character entity reference.

toString

public String toString()
Visualize this character reference as a string.

Returns: A string with the character and kernel.

HTML Parser is an open source library released under LGPL. SourceForge.net