|
EclipseLink 2.5.0, build 'v20130507-3faac2b' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.jpa.jpql.tools.utility.XmlEscapeCharacterConverter
public final class XmlEscapeCharacterConverter
This converter handles references when dealing with text or markup in an XML document. Those references (escape characters) are defined in ISO-8859-1 Reference.
The conversion supports both converting a numeric character reference (&#nnnn; where nnnn is the code point in decimal form or &xhhhh; where hhhh is the code point in hexadecimal point) and a character entity reference (&name; where name is the case-sensitive name of the entity).
Field Summary | |
---|---|
static java.lang.String |
AMPERSAND_ENTITY_NAME
The entity name for ampersand: &. |
static java.lang.String |
APOSTROPHE_ENTITY_NAME
The entity name for apostrophe: '. |
static java.lang.String |
GREATER_THAN_ENTITY_NAME
The entity name for greater-than symbol: >. |
static java.lang.String |
LESS_THAN_ENTITY_NAME
The entity name for less-than symbol: <. |
static java.lang.String |
QUOTATION_MARK_NAME
The entity name for quotation mark: ". |
Method Summary | |
---|---|
static java.lang.String |
escape(java.lang.String value,
int[] positions)
Converts the characters that are reserved in an XML document the given string may have into their corresponding references (escape characters) using the character entity reference. |
static java.lang.String |
getCharacter(java.lang.String reference)
Returns the Unicode character for the given reference (which is either a numeric character reference or a character entity reference). |
static java.lang.String |
getEscapeCharacter(char character)
Returns the escaped character for the given reserved character. |
static boolean |
isReserved(char character)
Determines if the given character is one of the XML/HTML reserved characters. |
static void |
reposition(java.lang.CharSequence query,
int[] positions)
Re-adjusts the given positions, which is based on the non-escaped version of the given query, by making sure it is pointing at the same position within query, which contains references (escape characters). |
static java.lang.String |
unescape(java.lang.String value,
int[] position)
Converts the references (escape characters) the given string may have into their corresponding Unicode characters. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String AMPERSAND_ENTITY_NAME
public static final java.lang.String APOSTROPHE_ENTITY_NAME
public static final java.lang.String GREATER_THAN_ENTITY_NAME
public static final java.lang.String LESS_THAN_ENTITY_NAME
public static final java.lang.String QUOTATION_MARK_NAME
Method Detail |
---|
public static java.lang.String escape(java.lang.String value, int[] positions)
value
- A string that may contain characters that need to be escapedpositions
- This array of length one or two can be used to adjust the position of the
cursor or a text range within the string during the conversion of the reserved characters
public static java.lang.String getCharacter(java.lang.String reference)
reference
- The numeric character or character entity reference stripped of the leading
ampersand and trailing semi-colon
null
if the
reference is invalid or unknownpublic static java.lang.String getEscapeCharacter(char character)
character
- The reserved character to retrieve its escape character with the entity name
null
public static boolean isReserved(char character)
character
- The character to verify if it's one of the reserved characters
true
if the given character is defined as a reserved characters;
false
otherwisepublic static void reposition(java.lang.CharSequence query, int[] positions)
The escape characters are either the character entity references or the numeric character references used in an XML document.
Important: The given query should contain the exact same amount of whitespace than the query used to calculate the given positions.
query
- The query that may contain escape characterspositions
- The position within the non-escaped version of the given query, which is
either a single element position or two positions that is used as a text rangepublic static java.lang.String unescape(java.lang.String value, int[] position)
value
- A string that may contain escape charactersposition
- This array of length one can be used to adjust the position of the cursor
within the string during the conversion of the escape characters
|
EclipseLink 2.5.0, build 'v20130507-3faac2b' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |