• Home
• net.htmlparser
• jericho-html
• 1.5-dev1
• source code
• NumericCharacterReference.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

doc.api.au.id.jericho.lib.html.NumericCharacterReference.html Maven / Gradle / Ivy

  

  
    Package 
  
  Class 
  
    Tree 
  
    Deprecated 
  
    Index 
  
    Help 
  









 PREV CLASS 
 NEXT CLASS

  FRAMES   
 NO FRAMES   
 






  SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD









au.id.jericho.lib.html


Class NumericCharacterReference
java.lang.Object
  au.id.jericho.lib.html.Segment
      au.id.jericho.lib.html.CharacterReference
          au.id.jericho.lib.html.NumericCharacterReference


All Implemented Interfaces: 
java.lang.CharSequence, java.lang.Comparable



public class NumericCharacterReference
extends CharacterReference


Represents an HTML Numeric Character Reference.
 

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

 NumericCharacterReference objects are created using one of the following methods:
 

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




See Also:
CharacterReference












Field Summary


 


Fields inherited from class au.id.jericho.lib.html.CharacterReference


ApostropheEncoded, INVALID_CODE_POINT


 









Method Summary



static java.lang.String
encode(java.lang.CharSequence unencodedText)



          Encodes the specified text, escaping special characters into numeric character references.



static java.lang.String
encodeDecimal(java.lang.CharSequence unencodedText)



          Encodes the specified text, escaping special characters into decimal numeric character references.



static java.lang.String
encodeHexadecimal(java.lang.CharSequence unencodedText)



          Encodes the specified text, escaping special characters into hexadecimal numeric character references.



 java.lang.String
getCharacterReferenceString()



          Returns the correct encoded form of this numeric character reference.



static java.lang.String
getCharacterReferenceString(int codePoint)



          Returns the numeric character reference encoded form of the specified Unicode code point.



 java.lang.String
getDebugInfo()



          Returns a string representation of this object useful for debugging purposes.



 boolean
isDecimal()



          Indicates whether this numeric character reference is in decimal format.



 boolean
isHexadecimal()



          Indicates whether this numeric character reference is in hexadecimal format.


 


Methods inherited from class au.id.jericho.lib.html.CharacterReference


decode, decodeCollapseWhiteSpace, encodeWithWhiteSpaceFormatting, getChar, getCodePoint, getCodePointFromCharacterReferenceString, getDecimalCharacterReferenceString, getDecimalCharacterReferenceString, getHexadecimalCharacterReferenceString, getHexadecimalCharacterReferenceString, getUnicodeText, getUnicodeText, parse, reencode, requiresEncoding


 


Methods inherited from class au.id.jericho.lib.html.Segment


charAt, compareTo, encloses, encloses, equals, findAllCharacterReferences, findAllComments, findAllElements, findAllElements, findAllStartTags, findAllStartTags, findAllStartTags, findFormControls, findFormFields, findWords, getBegin, getEnd, getSourceText, getSourceTextNoWhitespace, hashCode, ignoreWhenParsing, isComment, isWhiteSpace, length, parseAttributes, subSequence, toString


 


Methods inherited from class java.lang.Object


getClass, notify, notifyAll, wait, wait, wait


 














Method Detail




isDecimal
public boolean isDecimal()

Indicates whether this numeric character reference is in decimal format.
 (eg ">")
 

 This flag is set depending on whether character reference in the source document was in decimal or hexadecimal format.



Returns:
true if this numeric character reference is in decimal format, otherwise false.





isHexadecimal
public boolean isHexadecimal()

Indicates whether this numeric character reference is in hexadecimal format.
 (eg ">")
 

 This flag is set depending on whether character reference in the source document was in hexadecimal or decimal format.



Returns:
true if this numeric character reference is in hexadecimal format, otherwise false.





encode
public static java.lang.String encode(java.lang.CharSequence unencodedText)

Encodes the specified text, escaping special characters into numeric character references.
 

 Each character is encoded only if the 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
 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 numeric character references only, use the encodeHexadecimal(CharSequence) method instead.


Parameters:
unencodedText - the text to encode.
Returns:
the encoded string.
See Also:
CharacterReference.decode(CharSequence encodedText)





encodeDecimal
public static java.lang.String encodeDecimal(java.lang.CharSequence unencodedText)

Encodes the specified text, escaping special characters into decimal numeric character references.
 

 Each character is encoded only if the 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 numeric character references only, use the encodeHexadecimal(CharSequence) method instead.


Parameters:
unencodedText - the text to encode.
Returns:
the encoded string.
See Also:
CharacterReference.decode(CharSequence encodedText)





encodeHexadecimal
public static java.lang.String encodeHexadecimal(java.lang.CharSequence unencodedText)

Encodes the specified text, escaping special characters into hexadecimal numeric character references.
 

 Each character is encoded only if the 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 numeric character references only, use the encodeDecimal(CharSequence) method instead.


Parameters:
unencodedText - the text to encode.
Returns:
the encoded string.
See Also:
CharacterReference.decode(CharSequence encodedText)





getCharacterReferenceString
public java.lang.String getCharacterReferenceString()

Returns the correct encoded form of this numeric character reference.
 

 The returned string will use the same radix as the original character reference in the source document,
 i.e. decimal format if isDecimal() is true, and hexadecimal format if 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 will recognise certain invalid forms of character references, as detailed in the decode(CharSequence encodedText) method.
 

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

 

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


Specified by:
getCharacterReferenceString in class CharacterReference



Returns:
the correct encoded form of this numeric character reference.
See Also:
CharacterReference.getCharacterReferenceString(int codePoint)





getCharacterReferenceString
public static java.lang.String getCharacterReferenceString(int codePoint)

Returns the numeric character reference encoded form of the specified Unicode code point.
 

 This method returns the character reference in decimal format, and is exactly the same as calling
 CharacterReference.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 CharacterReference.getHexadecimalCharacterReferenceString(int codePoint) method instead.
 

 

  
Examples:
   
NumericCharacterReference.getCharacterReferenceString(62) returns ">"
   
NumericCharacterReference.getCharacterReferenceString('>') returns ">"
 



Returns:
the numeric character reference encoded form of the specified Unicode code point.
See Also:
CharacterReference.getCharacterReferenceString(int codePoint)





getDebugInfo
public java.lang.String getDebugInfo()

Description copied from class: Segment
Returns a string representation of this object useful for debugging purposes.


Overrides:
getDebugInfo in class Segment



Returns:
a string representation of this object useful for debugging purposes.














  

  
    Package 
  
  Class 
  
    Tree 
  
    Deprecated 
  
    Index 
  
    Help 
  









 PREV CLASS 
 NEXT CLASS

  FRAMES   
 NO FRAMES   
 






  SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD