Top Description Fields Constructors Methods

org.apache.commons.text.translate

public Class EntityArrays

Class Inheritance

extends Object

java.lang.Object
org.apache.commons.text.translate.EntityArrays

Imports

java.util.Collections, .HashMap, .Map, .Map.Entry, java.util.stream.Collectors

Class holding various entity data for HTML and XML - generally for use with the LookupTranslator. All Maps are generated using java.util.Collections.unmodifiableMap().

Since: 1.0

Field Summary

Modifier and Type	Field and Description
public static final Map<CharSequence, CharSequence>	APOS_ESCAPE A Map<CharSequence, CharSequence> to escape the apostrophe character to its XML character entity.
public static final Map<CharSequence, CharSequence>	APOS_UNESCAPE Reverse of `APOS_ESCAPE` for unescaping purposes.
public static final Map<CharSequence, CharSequence>	BASIC_ESCAPE A Map<CharSequence, CharSequence> to escape the basic XML and HTML character entities.
public static final Map<CharSequence, CharSequence>	BASIC_UNESCAPE Reverse of `BASIC_ESCAPE` for unescaping purposes.
public static final Map<CharSequence, CharSequence>	HTML40_EXTENDED_ESCAPE A Map<CharSequence, CharSequence> to escape additional character entity references.
public static final Map<CharSequence, CharSequence>	HTML40_EXTENDED_UNESCAPE Reverse of `HTML40_EXTENDED_ESCAPE` for unescaping purposes.
public static final Map<CharSequence, CharSequence>	ISO8859_1_ESCAPE A Map<CharSequence, CharSequence> to escape ISO-8859-1 characters to their named HTML 3.x equivalents.
public static final Map<CharSequence, CharSequence>	ISO8859_1_UNESCAPE Reverse of `ISO8859_1_ESCAPE` for unescaping purposes.
public static final Map<CharSequence, CharSequence>	JAVA_CTRL_CHARS_ESCAPE A Map<CharSequence, CharSequence> to escape the Java control characters.
public static final Map<CharSequence, CharSequence>	JAVA_CTRL_CHARS_UNESCAPE Reverse of `JAVA_CTRL_CHARS_ESCAPE` for unescaping purposes.

Constructor Summary

Access	Constructor and Description
public	EntityArrays() Deprecated Will be private. Deprecated, only defines static methods.

Method Summary

Modifier and Type	Method and Description
public static Map<CharSequence, CharSequence>	Returns: Map<String, String> inverted array. invert(final Map<CharSequence, CharSequence> Map<String, String> to be inverted. map) Inverts an escape Map into an unescape Map.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

APOS_ESCAPE	back to summary
public static final Map<CharSequence, CharSequence> APOS_ESCAPE A Map<CharSequence, CharSequence> to escape the apostrophe character to its XML character entity.

APOS_UNESCAPE	back to summary
public static final Map<CharSequence, CharSequence> APOS_UNESCAPE Reverse of `APOS_ESCAPE` for unescaping purposes.

BASIC_ESCAPE	back to summary
public static final Map<CharSequence, CharSequence> BASIC_ESCAPE A Map<CharSequence, CharSequence> to escape the basic XML and HTML character entities. Namely: `" & < >`

BASIC_UNESCAPE	back to summary
public static final Map<CharSequence, CharSequence> BASIC_UNESCAPE Reverse of `BASIC_ESCAPE` for unescaping purposes.

HTML40_EXTENDED_ESCAPE	back to summary
public static final Map<CharSequence, CharSequence> HTML40_EXTENDED_ESCAPE A Map<CharSequence, CharSequence> 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.

HTML40_EXTENDED_UNESCAPE	back to summary
public static final Map<CharSequence, CharSequence> HTML40_EXTENDED_UNESCAPE Reverse of `HTML40_EXTENDED_ESCAPE` for unescaping purposes.

ISO8859_1_ESCAPE	back to summary
public static final Map<CharSequence, CharSequence> ISO8859_1_ESCAPE A Map<CharSequence, CharSequence> to escape ISO-8859-1 characters to their named HTML 3.x equivalents.

ISO8859_1_UNESCAPE	back to summary
public static final Map<CharSequence, CharSequence> ISO8859_1_UNESCAPE Reverse of `ISO8859_1_ESCAPE` for unescaping purposes.

JAVA_CTRL_CHARS_ESCAPE	back to summary
public static final Map<CharSequence, CharSequence> JAVA_CTRL_CHARS_ESCAPE A Map<CharSequence, CharSequence> to escape the Java control characters. Namely: `\b \n \t \f \r`

JAVA_CTRL_CHARS_UNESCAPE	back to summary
public static final Map<CharSequence, CharSequence> JAVA_CTRL_CHARS_UNESCAPE Reverse of `JAVA_CTRL_CHARS_ESCAPE` for unescaping purposes.

Constructor Detail

EntityArrays

back to summary

public EntityArrays()

Deprecated

Will be private.

Deprecated, only defines static methods.

Annotations

@Deprecated

Method Detail

invert

back to summary

public static Map<CharSequence, CharSequence> invert(final Map<CharSequence, CharSequence> map)

Inverts an escape Map into an unescape Map.

Parameters

map:Map<CharSequence, CharSequence>: Map<String, String> to be inverted.

Returns:Map<CharSequence, CharSequence>

Map<String, String> inverted array.