Top Description Fields Constructors Methods
org.apache.commons.lang3.text.translate

public Class EntityArrays

extends Object
Class Inheritance
Annotations
@Deprecated

Deprecated

As of 3.6, use Apache Commons Text EntityArrays.

Class holding various entity data for HTML and XML - generally for use with the LookupTranslator. All arrays are of length [*][2].
Since
3.0

Field Summary

Modifier and TypeField and Description
private static final String[][]
APOS_ESCAPE

private static final String[][]
APOS_UNESCAPE

private static final String[][]
BASIC_ESCAPE

private static final String[][]
BASIC_UNESCAPE

private static final String[][]
HTML40_EXTENDED_ESCAPE

private static final String[][]
HTML40_EXTENDED_UNESCAPE

private static final String[][]
ISO8859_1_ESCAPE

private static final String[][]
ISO8859_1_UNESCAPE

private static final String[][]
JAVA_CTRL_CHARS_ESCAPE

private static final String[][]
JAVA_CTRL_CHARS_UNESCAPE

Constructor Summary

AccessConstructor and Description
public
EntityArrays()
Deprecated Will be removed in 4.0.0.

Constructs a new instance.

Method Summary

Modifier and TypeMethod and Description
public static String[][]

Returns:

the mapping table.
APOS_ESCAPE()

Mapping to escape the apostrophe character to its XML character entity.

public static String[][]

Returns:

the mapping table.
APOS_UNESCAPE()

Reverse of APOS_ESCAPE() for unescaping purposes.

public static String[][]

Returns:

the mapping table.
BASIC_ESCAPE()

Mapping to escape the basic XML and HTML character entities.

public static String[][]

Returns:

the mapping table.
BASIC_UNESCAPE()

Reverse of BASIC_ESCAPE() for unescaping purposes.

public static String[][]

Returns:

the mapping table.
HTML40_EXTENDED_ESCAPE()

Mapping to escape additional character entity references.

public static String[][]

Returns:

the mapping table.
HTML40_EXTENDED_UNESCAPE()

Reverse of HTML40_EXTENDED_ESCAPE() for unescaping purposes.

public static String[][]

Returns:

String[][] inverted array.
invert(final String[][]
String[][] to be inverted.
array)

Used to invert an escape array into an unescape array.

public static String[][]

Returns:

the mapping table.
ISO8859_1_ESCAPE()

Mapping to escape ISO-8859-1 characters to their named HTML 3.x equivalents.

public static String[][]

Returns:

the mapping table.
ISO8859_1_UNESCAPE()

Reverse of ISO8859_1_ESCAPE() for unescaping purposes.

public static String[][]

Returns:

the mapping table.
JAVA_CTRL_CHARS_ESCAPE()

Mapping to escape the Java control characters.

public static String[][]

Returns:

the mapping table.
JAVA_CTRL_CHARS_UNESCAPE()

Reverse of JAVA_CTRL_CHARS_ESCAPE() for unescaping purposes.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

APOS_ESCAPEback to summary
private static final String[][] APOS_ESCAPE
APOS_UNESCAPEback to summary
private static final String[][] APOS_UNESCAPE
BASIC_ESCAPEback to summary
private static final String[][] BASIC_ESCAPE
BASIC_UNESCAPEback to summary
private static final String[][] BASIC_UNESCAPE
HTML40_EXTENDED_ESCAPEback to summary
private static final String[][] HTML40_EXTENDED_ESCAPE
HTML40_EXTENDED_UNESCAPEback to summary
private static final String[][] HTML40_EXTENDED_UNESCAPE
ISO8859_1_ESCAPEback to summary
private static final String[][] ISO8859_1_ESCAPE
ISO8859_1_UNESCAPEback to summary
private static final String[][] ISO8859_1_UNESCAPE
JAVA_CTRL_CHARS_ESCAPEback to summary
private static final String[][] JAVA_CTRL_CHARS_ESCAPE
JAVA_CTRL_CHARS_UNESCAPEback to summary
private static final String[][] JAVA_CTRL_CHARS_UNESCAPE

Constructor Detail

EntityArraysback to summary
public EntityArrays()

Deprecated

Will be removed in 4.0.0.

Constructs a new instance.

Annotations
@Deprecated

Method Detail

APOS_ESCAPEback to summary
public static String[][] APOS_ESCAPE()

Mapping to escape the apostrophe character to its XML character entity.

Returns:String[][]

the mapping table.

APOS_UNESCAPEback to summary
public static String[][] APOS_UNESCAPE()

Reverse of APOS_ESCAPE() for unescaping purposes.

Returns:String[][]

the mapping table.

BASIC_ESCAPEback to summary
public static String[][] BASIC_ESCAPE()

Mapping to escape the basic XML and HTML character entities. Namely: " & < >

Returns:String[][]

the mapping table.

BASIC_UNESCAPEback to summary
public static String[][] BASIC_UNESCAPE()

Reverse of BASIC_ESCAPE() for unescaping purposes.

Returns:String[][]

the mapping table.

HTML40_EXTENDED_ESCAPEback to summary
public static String[][] HTML40_EXTENDED_ESCAPE()

Mapping to escape additional character entity references. Note that this must be used with ISO8859_1_ESCAPE() to get the full list of HTML 4.0 character entities.

Returns:String[][]

the mapping table.

HTML40_EXTENDED_UNESCAPEback to summary
public static String[][] HTML40_EXTENDED_UNESCAPE()

Reverse of HTML40_EXTENDED_ESCAPE() for unescaping purposes.

Returns:String[][]

the mapping table.

invertback to summary
public static String[][] invert(final String[][] array)

Used to invert an escape array into an unescape array.

Parameters
array:String[][]

String[][] to be inverted.

Returns:String[][]

String[][] inverted array.

ISO8859_1_ESCAPEback to summary
public static String[][] ISO8859_1_ESCAPE()

Mapping to escape ISO-8859-1 characters to their named HTML 3.x equivalents.

Returns:String[][]

the mapping table.

ISO8859_1_UNESCAPEback to summary
public static String[][] ISO8859_1_UNESCAPE()

Reverse of ISO8859_1_ESCAPE() for unescaping purposes.

Returns:String[][]

the mapping table.

JAVA_CTRL_CHARS_ESCAPEback to summary
public static String[][] JAVA_CTRL_CHARS_ESCAPE()

Mapping to escape the Java control characters. Namely: \b \n \t \f \r

Returns:String[][]

the mapping table.

JAVA_CTRL_CHARS_UNESCAPEback to summary
public static String[][] JAVA_CTRL_CHARS_UNESCAPE()

Reverse of JAVA_CTRL_CHARS_ESCAPE() for unescaping purposes.

Returns:String[][]

the mapping table.