Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adding javadoc 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@1079249 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Henri Yandell 2011-03-08 06:00:22 +00:00
parent 8542ccb689
commit 803687227f
1 changed files with 37 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
src/main/java/org/apache/commons/lang3/text/translate/EntityArrays.java
View File

@ -27,6 +27,10 @@ package org.apache.commons.lang3.text.translate;
*/
public class EntityArrays {
/**
* Mapping to escape <a href="https://secure.wikimedia.org/wikipedia/en/wiki/ISO/IEC_8859-1">ISO-8859-1</a>
* characters to their named HTML 3.x equivalents.
*/
public static String[][] ISO8859_1_ESCAPE() { return ISO8859_1_ESCAPE.clone(); }
private static final String[][] ISO8859_1_ESCAPE = {
{"\u00A0", "&nbsp;"}, // non-breaking space
@ -127,10 +131,17 @@ public class EntityArrays {
{"\u00FF", "&yuml;"}, // ÿ - lowercase y, umlaut
};
/**
* Reverse of {@link #ISO8859_1_ESCAPE()} for unescaping purposes.
*/
public static String[][] ISO8859_1_UNESCAPE() { return ISO8859_1_UNESCAPE.clone(); }
private static final String[][] ISO8859_1_UNESCAPE = invert(ISO8859_1_ESCAPE);
// http://www.w3.org/TR/REC-html40/sgml/entities.html
/**
* Mapping to escape additional <a href="http://www.w3.org/TR/REC-html40/sgml/entities.html">character entity
* references</a>. Note that this must be used with {@link #ISO8859_1_ESCAPE()} to get the full list of
* HTML 4.0 character entities.
*/
public static String[][] HTML40_EXTENDED_ESCAPE() { return HTML40_EXTENDED_ESCAPE.clone(); }
private static final String[][] HTML40_EXTENDED_ESCAPE = {
// <!-- Latin Extended-B -->
@ -329,9 +340,17 @@ public class EntityArrays {
{"\u20AC", "&euro;"}, // -- euro sign, U+20AC NEW -->
};
/**
* Reverse of {@link #HTML40_EXTENDED_ESCAPE()} for unescaping purposes.
*/
public static String[][] HTML40_EXTENDED_UNESCAPE() { return HTML40_EXTENDED_UNESCAPE.clone(); }
private static final String[][] HTML40_EXTENDED_UNESCAPE = invert(HTML40_EXTENDED_ESCAPE);
/**
* Mapping to escape the basic XML and HTML character entities.
*
* Namely: {@code " & < >}
*/
public static String[][] BASIC_ESCAPE() { return BASIC_ESCAPE.clone(); }
private static final String[][] BASIC_ESCAPE = {
{"\"", "&quot;"}, // " - double-quote
@ -340,17 +359,31 @@ public class EntityArrays {
{">", "&gt;"}, // > - greater-than
};
/**
* Reverse of {@link #BASIC_ESCAPE()} for unescaping purposes.
*/
public static String[][] BASIC_UNESCAPE() { return BASIC_UNESCAPE.clone(); }
private static final String[][] BASIC_UNESCAPE = invert(BASIC_ESCAPE);
/**
* Mapping to escape the apostrophe character to its XML character entity.
*/
public static String[][] APOS_ESCAPE() { return APOS_ESCAPE.clone(); }
private static final String[][] APOS_ESCAPE = {
{"'", "&apos;"}, // XML apostrophe
};
/**
* Reverse of {@link #APOS_ESCAPE()} for unescaping purposes.
*/
public static String[][] APOS_UNESCAPE() { return APOS_UNESCAPE.clone(); }
private static final String[][] APOS_UNESCAPE = invert(APOS_ESCAPE);
/**
* Mapping to escape the Java control characters.
*
* Namely: {@code \b \n \t \f \r}
*/
public static String[][] JAVA_CTRL_CHARS_ESCAPE() { return JAVA_CTRL_CHARS_ESCAPE.clone(); }
private static final String[][] JAVA_CTRL_CHARS_ESCAPE = {
{"\b", "\\b"},
@ -360,6 +393,9 @@ public class EntityArrays {
{"\r", "\\r"}
};
/**
* Reverse of {@link #JAVA_CTRL_CHARS_ESCAPE()} for unescaping purposes.
*/
public static String[][] JAVA_CTRL_CHARS_UNESCAPE() { return JAVA_CTRL_CHARS_UNESCAPE.clone(); }
private static final String[][] JAVA_CTRL_CHARS_UNESCAPE = invert(JAVA_CTRL_CHARS_ESCAPE);