org.htmlparser.util.CharacterReference Maven / Gradle / Ivy
Show all versions of bboss-htmlparser Show documentation
/*
* CharacterReference.java
*
* Created on February 5, 2004, 9:40 PM
*/
package org.htmlparser.util;
import java.io.Serializable;
import org.htmlparser.util.sort.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.
*/
public class CharacterReference
implements
Serializable,
Cloneable,
Ordered
{
/**
* The character value as an integer.
*/
protected int mCharacter;
/**
* This entity reference kernel.
* The text between the ampersand and the semicolon.
*/
protected String mKernel;
/**
* Construct a CharacterReference with the character and kernel given.
* @param kernel The kernel in the equivalent character entity reference.
* @param character The character needing encoding.
*/
public CharacterReference (String kernel, int character)
{
mKernel = kernel;
mCharacter = character;
if (null == mKernel)
mKernel = "";
}
/**
* Get this CharacterReference's kernel.
* @return The kernel in the equivalent character entity reference.
*/
public String getKernel ()
{
return (mKernel);
}
/**
* Set this CharacterReference's kernel.
* This is used to avoid creating a new object to perform a binary search.
* @param kernel The kernel in the equivalent character entity reference.
*/
void setKernel (String kernel)
{
mKernel = kernel;
}
/**
* Get the character needing translation.
* @return The character.
*/
public int getCharacter ()
{
return (mCharacter);
}
/**
* Set the character.
* This is used to avoid creating a new object to perform a binary search.
* @param character The character needing translation.
*/
void setCharacter (int character)
{
mCharacter = character;
}
/**
* Visualize this character reference as a string.
* @return A string with the character and kernel.
*/
public String toString ()
{
String hex;
StringBuffer ret;
ret = new StringBuffer (6 + 8 + 2); // max 8 in string
hex = Integer.toHexString (getCharacter ());
ret.append ("\\u");
for (int i = hex.length (); i < 4; i++)
ret.append ("0");
ret.append (hex);
ret.append ("[");
ret.append (getKernel ());
ret.append ("]");
return (ret.toString ());
}
//
// Ordered interface
//
/**
* Compare one reference to another.
* @see org.htmlparser.util.sort.Ordered
*/
public int compare (Object that)
{
CharacterReference r;
r = (CharacterReference)that;
return (getKernel ().compareTo (r.getKernel ()));
}
}