Class Transform

java.lang.Object

org.apache.logging.log4j.core.util.Transform

public final class Transform
extends Object

Utility class for transforming strings.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	CDATA_EMBEDED_END
private static final String	CDATA_END
private static final int	CDATA_END_LEN
private static final String	CDATA_PSEUDO_END
private static final String	CDATA_START
private static final char	REPLACEMENT_CHAR

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Transform()

Method Summary

Modifier and Type	Method	Description
static void	appendEscapingCData(StringBuilder buf, String str)	Ensures that embedded CDEnd strings (]]>) are handled properly within message, NDC and throwable tag text.
private static void	appendEscapingHtmlTags(String input, int i, int length, StringBuilder buf)
private static void	appendSanitizedXml10(String input, int start, int end, StringBuilder out)
static String	escapeHtmlTags(String input)	Escapes characters in a string for safe inclusion in HTML or XML text.
static String	escapeJsonControlCharacters(String input)	This method takes a string which may contain JSON reserved chars and escapes them.
private static boolean	isHtmlTagCharacter(int cp)
private static boolean	isValidXml10(int codePoint)	Checks if a code point is valid in XML 1.0.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CDATA_START

private static final String CDATA_START

See Also:

• Constant Field Values

CDATA_END

private static final String CDATA_END

See Also:

• Constant Field Values

CDATA_PSEUDO_END

private static final String CDATA_PSEUDO_END

See Also:

• Constant Field Values

CDATA_EMBEDED_END

private static final String CDATA_EMBEDED_END

See Also:

• Constant Field Values

CDATA_END_LEN

private static final int CDATA_END_LEN

REPLACEMENT_CHAR

private static final char REPLACEMENT_CHAR

See Also:

• Constant Field Values

Constructor Details

Transform

private Transform()

Method Details

escapeHtmlTags

public static String escapeHtmlTags(String input)

Escapes characters in a string for safe inclusion in HTML or XML text.

Replaces the characters <, >, &, " and ' with their corresponding entity references (<, >, &, ", and '). Any code point that is invalid in XML 1.0 is replaced with the Unicode replacement character U+FFFD.

Parameters:

input - The text to be escaped; may be null or empty.

Returns:

The escaped string, or the original input if no changes were required.

appendEscapingCData

public static void appendEscapingCData(StringBuilder buf,
 String str)

Ensures that embedded CDEnd strings (]]>) are handled properly within message, NDC and throwable tag text.

Parameters:

buf - StringBuilder holding the XML data to this point. The initial CDStart (<![CDATA[) and final CDEnd (]]>) of the CDATA section are the responsibility of the calling method.

str - The String that is inserted into an existing CDATA Section within buf.

escapeJsonControlCharacters

public static String escapeJsonControlCharacters(String input)

This method takes a string which may contain JSON reserved chars and escapes them.

Parameters:

input - The text to be converted.

Returns:

The input string with the special characters replaced.

appendEscapingHtmlTags

private static void appendEscapingHtmlTags(String input,
 int i,
 int length,
 StringBuilder buf)

isHtmlTagCharacter

private static boolean isHtmlTagCharacter(int cp)

appendSanitizedXml10

private static void appendSanitizedXml10(String input,
 int start,
 int end,
 StringBuilder out)

isValidXml10

private static boolean isValidXml10(int codePoint)

Checks if a code point is valid in XML 1.0.

Parameters:

codePoint - a code point between 0 and Character.MAX_CODE_POINT

Returns:

true if it is a valid XML 1.0 code point