Class XmlEncodingUtils

java.lang.Object

org.frankframework.util.XmlEncodingUtils

@NullMarked
public class XmlEncodingUtils
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final char	REPLACE_NON_XML_CHAR

Method Summary

Modifier and Type	Method	Description
static String	decodeChars(String string)	Translates the five reserved XML characters (< > & " ') to their normal selves
static String	encodeChars(char[] chars, int offset, int length, boolean escapeNewLines)	Translates special characters to xml equivalents like > and &.
static @Nullable String	encodeChars(@Nullable String string)	See encodeChars(String, boolean).
static @Nullable String	encodeChars(@Nullable String string, boolean escapeNewLines)	Translates special characters to XML equivalents like > and &.
static @Nullable String	encodeCharsAndReplaceNonValidXmlCharacters(@Nullable String string)
static boolean	isPrintableUnicodeChar(int c)
static boolean	isPrintableUnicodeChar(int c, boolean allowUnicodeSupplementaryCharacters)
static @Nullable String	readXml(byte[] source, String defaultEncoding)
static @Nullable String	readXml(InputStream inputStream, String defaultCharset)	Reads binary XML data and uses the XML declaration encoding to turn it into character data.
static int	replaceNonPrintableCharacters(char[] buf, int offset, int len)	Replaces non-unicode-characters by '0x00BF' (inverted question mark).
static @Nullable String	replaceNonValidXmlCharacters(@Nullable String string)	Replaces non-unicode-characters by '0x00BF' (inverted question mark) appended with #, the character number and ;.
static @Nullable String	replaceNonValidXmlCharacters(@Nullable String string, char to, boolean appendCharNum, boolean allowUnicodeSupplementaryCharacters)
static String	stripNonValidXmlCharacters(String string, boolean allowUnicodeSupplementaryCharacters)

Methods inherited from class Object

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

Field Details

REPLACE_NON_XML_CHAR

public static final char REPLACE_NON_XML_CHAR

See Also:

• Constant Field Values

Method Details

encodeChars

public static @Nullable String encodeChars(@Nullable String string)

See encodeChars(String, boolean).

encodeChars

public static @Nullable String encodeChars(@Nullable String string,
 boolean escapeNewLines)

Translates special characters to XML equivalents like > and &. Please note that non-valid XML chars are not changed, hence you might want to use replaceNonValidXmlCharacters(String) or stripNonValidXmlCharacters(String, boolean) too.

encodeCharsAndReplaceNonValidXmlCharacters

public static @Nullable String encodeCharsAndReplaceNonValidXmlCharacters(@Nullable String string)

encodeChars

public static String encodeChars(char[] chars,
 int offset,
 int length,
 boolean escapeNewLines)

Translates special characters to xml equivalents like > and &. Please note that non-valid xml chars are not changed, hence you might want to use replaceNonValidXmlCharacters(String) or stripNonValidXmlCharacters(String, boolean) too.

decodeChars

public static String decodeChars(String string)

Translates the five reserved XML characters (< > & " ') to their normal selves

replaceNonPrintableCharacters

public static int replaceNonPrintableCharacters(char[] buf,
 int offset,
 int len)

Replaces non-unicode-characters by '0x00BF' (inverted question mark).

replaceNonValidXmlCharacters

public static @Nullable String replaceNonValidXmlCharacters(@Nullable String string)

Replaces non-unicode-characters by '0x00BF' (inverted question mark) appended with #, the character number and ;.

replaceNonValidXmlCharacters

public static @Nullable String replaceNonValidXmlCharacters(@Nullable String string,
 char to,
 boolean appendCharNum,
 boolean allowUnicodeSupplementaryCharacters)

stripNonValidXmlCharacters

public static String stripNonValidXmlCharacters(String string,
 boolean allowUnicodeSupplementaryCharacters)

isPrintableUnicodeChar

public static boolean isPrintableUnicodeChar(int c)

isPrintableUnicodeChar

public static boolean isPrintableUnicodeChar(int c,
 boolean allowUnicodeSupplementaryCharacters)

readXml

public static @Nullable String readXml(InputStream inputStream,
 String defaultCharset)
                                throws IOException

Reads binary XML data and uses the XML declaration encoding to turn it into character data.

Throws:

IOException

readXml

public static @Nullable String readXml(byte[] source,
 String defaultEncoding)
                                throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException