Java Doc for NumericCharacterReference.java in  » HTML-Parser » jericho-html » au » id » jericho » lib » html » Java Source Code / Java DocumentationJava Source Code and Java Documentation

A numeric character reference can be one of two types:

Decimal Character Reference

A numeric character reference specifying the unicode code point in decimal notation.
This is signified by the absence of an 'x' character after the '#', (eg ">").

Hexadecimal Character Reference

A numeric character reference specifying the unicode code point in hexadecimal notation.
This is signified by the presence of an 'x' character after the '#', (eg ">").

Static methods to and strings and single characters can be found in the CharacterReference superclass.

NumericCharacterReference instances are obtained using one of the following methods:

• CharacterReference.parse(CharSequence characterReferenceText)
• Source.findNextCharacterReference(int pos)
• Source.findPreviousCharacterReference(int pos)
• Segment.findAllCharacterReferences

Each character is encoded only if the NumericCharacterReference.requiresEncoding(char) requiresEncoding(char) method would return true for that character.

This method encodes all character references in decimal format, and is exactly the same as calling NumericCharacterReference.encodeDecimal(CharSequence) .

To encode text using both character entity references and numeric character references, use the
CharacterReference.encode(CharSequence) method instead.

To encode text using hexadecimal character references only, use the NumericCharacterReference.encodeHexadecimal(CharSequence) method instead.
Parameters:
  unencodedText - the text to encode.

Each character is encoded only if the NumericCharacterReference.requiresEncoding(char) requiresEncoding(char) method would return true for that character.

To encode text using both character entity references and numeric character references, use the
CharacterReference.encode(CharSequence) method instead.

To encode text using hexadecimal character references only, use the NumericCharacterReference.encodeHexadecimal(CharSequence) method instead.
Parameters:
  unencodedText - the text to encode.

Each character is encoded only if the NumericCharacterReference.requiresEncoding(char) requiresEncoding(char) method would return true for that character.

To encode text using both character entity references and numeric character references, use the
CharacterReference.encode(CharSequence) method instead.

To encode text using decimal character references only, use the NumericCharacterReference.encodeDecimal(CharSequence) method instead.
Parameters:
  unencodedText - the text to encode.

The returned string uses the same radix as the original character reference in the source document, i.e.

Each character is encoded only if the NumericCharacterReference.requiresEncoding(char) requiresEncoding(char) method would return true for that character.

This method encodes all character references in decimal format, and is exactly the same as calling NumericCharacterReference.encodeDecimal(CharSequence) .

To encode text using both character entity references and numeric character references, use the
CharacterReference.encode(CharSequence) method instead.

To encode text using hexadecimal character references only, use the NumericCharacterReference.encodeHexadecimal(CharSequence) method instead.
Parameters:
  unencodedText - the text to encode. the encoded string.
See Also:   NumericCharacterReference.decode(CharSequence)

Each character is encoded only if the NumericCharacterReference.requiresEncoding(char) requiresEncoding(char) method would return true for that character.

To encode text using both character entity references and numeric character references, use the
CharacterReference.encode(CharSequence) method instead.

To encode text using hexadecimal character references only, use the NumericCharacterReference.encodeHexadecimal(CharSequence) method instead.
Parameters:
  unencodedText - the text to encode. the encoded string.
See Also:   NumericCharacterReference.decode(CharSequence)

Each character is encoded only if the NumericCharacterReference.requiresEncoding(char) requiresEncoding(char) method would return true for that character.

To encode text using both character entity references and numeric character references, use the
CharacterReference.encode(CharSequence) method instead.

To encode text using decimal character references only, use the NumericCharacterReference.encodeDecimal(CharSequence) method instead.
Parameters:
  unencodedText - the text to encode. the encoded string.
See Also:   NumericCharacterReference.decode(CharSequence)

The returned string uses the same radix as the original character reference in the source document, i.e. decimal format if NumericCharacterReference.isDecimal() is true, and hexadecimal format if NumericCharacterReference.isHexadecimal() is true.

Note that the returned string is not necessarily the same as the original source text used to create this object. This library recognises certain invalid forms of character references, as detailed in the NumericCharacterReference.decode(CharSequence) decode(CharSequence) method.

To retrieve the original source text, use the NumericCharacterReference.toString() toString() method instead.

Example:

CharacterReference.parse("&#62").getCharacterReferenceString() returns ">"

This method returns the character reference in decimal format, and is exactly the same as calling NumericCharacterReference.getDecimalCharacterReferenceString(int codePoint) .

To get either the character entity reference or numeric character reference, use the
CharacterReference.getCharacterReferenceString(int codePoint) method instead.

To get the character reference in hexadecimal format, use the NumericCharacterReference.getHexadecimalCharacterReferenceString(int codePoint) method instead.

Examples:

NumericCharacterReference.getCharacterReferenceString(62) returns ">"

NumericCharacterReference.getCharacterReferenceString('>') returns ">"

A numeric character reference in decimal format is referred to in this library as a decimal character reference. true if this numeric character reference specifies the unicode code point in decimal format, otherwise false.
See Also:   NumericCharacterReference.isHexadecimal()

A numeric character reference in hexadecimal format is referred to in this library as a hexadecimal character reference. true if this numeric character reference specifies the unicode code point in hexadecimal format, otherwise false.
See Also:   NumericCharacterReference.isDecimal()