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

This class, together with its subclasses, contains static methods to perform most required operations without having to instantiate an object.

Instances of this class are useful when the positions of character references in a source document are required, or to replace the found character references with customised text.

CharacterReference instances are obtained using one of the following methods:

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

All and are converted to their respective characters.

This is equivalent to CharacterReference.decode(CharSequence,boolean) decode(encodedText,false) .

Unterminated character references are dealt with according to the rules for text outside of attribute values in the .

Although character entity reference names are case sensitive, and in some cases differ from other entity references only by their case, some browsers also recognise them in a case-insensitive way. For this reason, all decoding methods in this library recognise character entity reference names even if they are in the wrong case.
Parameters:
  encodedText - the text to decode.

All and are converted to their respective characters.

Unterminated character references are dealt with according to the value of the insideAttributeValue parameter and the .

Although character entity reference names are case sensitive, and in some cases differ from other entity references only by their case, some browsers also recognise them in a case-insensitive way. For this reason, all decoding methods in this library recognise character entity reference names even if they are in the wrong case.
Parameters:
  encodedText - the text to decode.
Parameters:
  insideAttributeValue - specifies whether the encoded text is inside an attribute value.

Each character is encoded only if the CharacterReference.requiresEncoding(char) method would return true for that character, using its CharacterEntityReference if available, or a decimal NumericCharacterReference if its unicode code point is greater than U+007F.

The only exception to this is an (U+0027), which depending on the current setting of the static Config.IsApostropheEncoded property, is either left unencoded (default setting), or encoded as the numeric character reference "'".

This method never encodes an apostrophe into its character entity reference CharacterEntityReference._apos ' as this entity is not defined for use in HTML.

The encoding of the character follows the same rules as for each character in the CharacterReference.encode(CharSequence unencodedText) method.
Parameters:
  ch - the character to encode.

This performs the same encoding as the CharacterReference.encode(CharSequence) method, but also performs the following conversions:

• Line breaks, being Carriage Return (U+000D) or Line Feed (U+000A) characters, and Form Feed characters (U+000C) are converted to "<br />".

This method returns the encoded form of the unicode code point if one exists, otherwise it returns the encoded form.

The only exception to this is an (U+0027), which is encoded as the numeric character reference "'" instead of its character entity reference "'".

Examples:

CharacterReference.getCharacterReferenceString(62) returns ">"

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

CharacterReference.getCharacterReferenceString('☺') returns "☺"

The character reference must be at the start of the given text, but may contain other characters at the end.

If the text does not represent a valid character reference, this method returns CharacterReference.INVALID_CODE_POINT .

This is equivalent to CharacterReference.parse(CharSequence) parse(characterReferenceText) . CharacterReference.getCodePoint() , except that it returns CharacterReference.INVALID_CODE_POINT if an invalid character reference is specified instead of throwing a NullPointerException.

Example:

CharacterReference.getCodePointFromCharacterReferenceString(">") returns 38

Example:

CharacterReference.getDecimalCharacterReferenceString('>') returns ">"

Example:

CharacterReference.getHexadecimalCharacterReferenceString('>') returns ">"

Example:

CharacterReference.getUnicodeText('>') returns "U+003E"

The character reference must be at the start of the given text, but may contain other characters at the end. The CharacterReference.getEnd() getEnd() method can be used on the resulting object to determine at which character position the character reference ended.

If the text does not represent a valid character reference, this method returns null.

Unterminated character references are always accepted, regardless of the settings in the .

To decode all character references in a given text, use the CharacterReference.decode(CharSequence) method instead.

Example:

CharacterReference.parse(">").getChar() returns '>'

This process ensures that the specified encoded text does not contain any remaining unencoded characters.

IMPLEMENTATION NOTE: At present this method simply calls the CharacterReference.decode(CharSequence) decode method followed by the CharacterReference.encode(CharSequence) encode method, but a more efficient implementation may be used in future.
Parameters:
  encodedText - the text to re-encode.

This is the case if a exists for the character, or the unicode code point is greater than U+007F.

The only exception to this is an (U+0027), which only returns true if the static Config.IsApostropheEncoded property is currently set to true.
Parameters:
  ch - the character to test.

This can be the result of parsing a numeric character reference outside of the valid unicode range of 0x000000-0x10FFFF, or any other invalid character reference.

All and are converted to their respective characters.

This is equivalent to CharacterReference.decode(CharSequence,boolean) decode(encodedText,false) .

Unterminated character references are dealt with according to the rules for text outside of attribute values in the .

Although character entity reference names are case sensitive, and in some cases differ from other entity references only by their case, some browsers also recognise them in a case-insensitive way. For this reason, all decoding methods in this library recognise character entity reference names even if they are in the wrong case.
Parameters:
  encodedText - the text to decode. the decoded string.
See Also:   CharacterReference.encode(CharSequence)

All and are converted to their respective characters.

Unterminated character references are dealt with according to the value of the insideAttributeValue parameter and the .

Although character entity reference names are case sensitive, and in some cases differ from other entity references only by their case, some browsers also recognise them in a case-insensitive way. For this reason, all decoding methods in this library recognise character entity reference names even if they are in the wrong case.
Parameters:
  encodedText - the text to decode.
Parameters:
  insideAttributeValue - specifies whether the encoded text is inside an attribute value. the decoded string.
See Also:   CharacterReference.decode(CharSequence)
See Also:   CharacterReference.encode(CharSequence)

All leading and trailing white space is omitted, and any sections of internal white space are replaced by a single space.

The result is how the text would normally be rendered by a user agent, assuming it does not contain any tags.

Unterminated character references are dealt with according to the rules for text outside of attribute values in the . See the discussion of the insideAttributeValue parameter of the #decode(CharSequence, boolean insideAttributeValue) method for a more detailed explanation of this topic.
Parameters:
  text - the source text the decoded text with collapsed white space.
See Also:   FormControl.getPredefinedValues

Each character is encoded only if the CharacterReference.requiresEncoding(char) method would return true for that character, using its CharacterEntityReference if available, or a decimal NumericCharacterReference if its unicode code point is greater than U+007F.

The only exception to this is an (U+0027), which depending on the current setting of the static Config.IsApostropheEncoded property, is either left unencoded (default setting), or encoded as the numeric character reference "'".

This method never encodes an apostrophe into its character entity reference CharacterEntityReference._apos ' as this entity is not defined for use in HTML. See the comments in the CharacterEntityReference class for more information.

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

The encoding of the character follows the same rules as for each character in the CharacterReference.encode(CharSequence unencodedText) method.
Parameters:
  ch - the character to encode. a character reference if appropriate, otherwise a string containing the original character.

This performs the same encoding as the CharacterReference.encode(CharSequence) method, but also performs the following conversions:

• Line breaks, being Carriage Return (U+000D) or Line Feed (U+000A) characters, and Form Feed characters (U+000C) are converted to "<br />". CR/LF pairs are treated as a single line break.
• Multiple consecutive spaces are converted so that every second space is converted to " " while ensuring the last is always a normal space.
• Tab characters (U+0009) are converted as if they were four consecutive spaces.

The conversion of multiple consecutive spaces to alternating space/non-breaking-space allows the correct number of spaces to be rendered, but also allows the line to wrap in the middle of it.

Note that zero-width spaces (U+200B) are converted to the numeric character reference "​" through the normal encoding process, but IE6 does not render them properly either encoded or unencoded.

There is no method provided to reverse this encoding.
Parameters:
  unencodedText - the text to encode. the encoded string with whitespace formatting converted to markup.
See Also:   CharacterReference.encode(CharSequence)

If this character reference represents a unicode supplimentary code point, any bits outside of the least significant 16 bits of the code point are truncated, yielding an incorrect result. the character represented by this character reference.

The exact behaviour of this method depends on the class of this object. See the CharacterEntityReference.getCharacterReferenceString and NumericCharacterReference.getCharacterReferenceString methods for more details.

Examples:

CharacterReference.parse(">").getCharacterReferenceString() returns ">"

CharacterReference.parse(">").getCharacterReferenceString() returns "&#3e;"

This method returns the encoded form of the unicode code point if one exists, otherwise it returns the encoded form.

The only exception to this is an (U+0027), which is encoded as the numeric character reference "'" instead of its character entity reference "'".

Examples:

CharacterReference.getCharacterReferenceString(62) returns ">"

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

CharacterReference.getCharacterReferenceString('☺') returns "☺"

The character reference must be at the start of the given text, but may contain other characters at the end.

If the text does not represent a valid character reference, this method returns CharacterReference.INVALID_CODE_POINT .

This is equivalent to CharacterReference.parse(CharSequence) parse(characterReferenceText) . CharacterReference.getCodePoint() , except that it returns CharacterReference.INVALID_CODE_POINT if an invalid character reference is specified instead of throwing a NullPointerException.

Example:

CharacterReference.getCodePointFromCharacterReferenceString(">") returns 38

This is equivalent to CharacterReference.getDecimalCharacterReferenceString(int) getDecimalCharacterReferenceString ( CharacterReference.getCodePoint() ).

Example:

CharacterReference.parse(">").getDecimalCharacterReferenceString() returns ">"

Example:

CharacterReference.getDecimalCharacterReferenceString('>') returns ">"

This is equivalent to CharacterReference.getHexadecimalCharacterReferenceString(int) getHexadecimalCharacterReferenceString ( CharacterReference.getCodePoint() ).

Example:

CharacterReference.parse(">").getHexadecimalCharacterReferenceString() returns ">"

Example:

CharacterReference.getHexadecimalCharacterReferenceString('>') returns ">"

This is equivalent to CharacterReference.getUnicodeText(int) getUnicodeText(getCodePoint()) .

Example:

CharacterReference.parse(">").getUnicodeText() returns "U+003E"

Example:

CharacterReference.getUnicodeText('>') returns "U+003E"

Conversely, this library defines an unterminated character reference as one which does not end with a semicolon.

The SGML specification allows unterminated character references in some circumstances, and because the HTML 4.01 specification states simply that "authors may use SGML character references", it follows that they are also valid in HTML documents, although their use is strongly discouraged.

Unterminated character references are not allowed in XHTML documents. true if this character reference is terminated by a semicolon, otherwise false.
See Also:   CharacterReference.decode(CharSequence encodedText,boolean insideAttributeValue)

The character reference must be at the start of the given text, but may contain other characters at the end. The CharacterReference.getEnd() getEnd() method can be used on the resulting object to determine at which character position the character reference ended.

If the text does not represent a valid character reference, this method returns null.

Unterminated character references are always accepted, regardless of the settings in the .

To decode all character references in a given text, use the CharacterReference.decode(CharSequence) method instead.

Example:

CharacterReference.parse(">").getChar() returns '>'

This process ensures that the specified encoded text does not contain any remaining unencoded characters.

IMPLEMENTATION NOTE: At present this method simply calls the CharacterReference.decode(CharSequence) decode method followed by the CharacterReference.encode(CharSequence) encode method, but a more efficient implementation may be used in future.
Parameters:
  encodedText - the text to re-encode. the re-encoded string.

This is the case if a exists for the character, or the unicode code point is greater than U+007F.

The only exception to this is an (U+0027), which only returns true if the static Config.IsApostropheEncoded property is currently set to true.
Parameters:
  ch - the character to test. true if the specified character would need to be encoded in HTML text, otherwise false.