Package org.htmlparser.util

Class CharacterReference

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, Ordered
    public class CharacterReference
extends java.lang.Object
implements java.io.Serializable, java.lang.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.

    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int mCharacter
      The character value as an integer.
      protected java.lang.String mKernel
      This entity reference kernel.

    • Constructor Summary

      Constructors 
      Constructor Description
      CharacterReference​(java.lang.String kernel, int character)
      Construct a CharacterReference with the character and kernel given.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compare​(java.lang.Object that)
      Compare one reference to another.
      int getCharacter()
      Get the character needing translation.
      java.lang.String getKernel()
      Get this CharacterReference's kernel.
      java.lang.String toString()
      Visualize this character reference as a string.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • mCharacter

        protected int mCharacter
        The character value as an integer.

      • mKernel

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

    • Constructor Detail

      • CharacterReference

        public CharacterReference​(java.lang.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

      • getKernel

        public java.lang.String getKernel()
        Get this CharacterReference's kernel.
        Returns:
        The kernel in the equivalent character entity reference.

      • getCharacter

        public int getCharacter()
        Get the character needing translation.
        Returns:
        The character.

      • toString

        public java.lang.String toString()
        Visualize this character reference as a string.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string with the character and kernel.

      • compare

        public int compare​(java.lang.Object that)
        Compare one reference to another.
        Specified by:
        compare in interface Ordered
        Parameters:
        that - The object to compare this object against.
        Returns:
        A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the second.
        See Also:
        Ordered