com.android.ide.common.resources

Class ValueXmlHelper

java.lang.Object

com.android.ide.common.resources.ValueXmlHelper

public class ValueXmlHelper
extends java.lang.Object

Helper class to help with XML values resource file.

Constructor Summary

Constructors

Constructor and Description
ValueXmlHelper()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	escapeResourceString(java.lang.String string) Escapes a string resource value in compliance with the rules and this Android Cookbook recipe.
static java.lang.String	escapeResourceString(java.lang.String string, boolean escapeMarkupDelimiters) Escapes a string resource value in compliance with the rules and this Android Cookbook recipe.
static java.lang.String	escapeResourceStringAsXml(java.lang.String xml) Escapes a string resource value in compliance with the rules and this Android Cookbook recipe.
static java.lang.String	unescapeResourceString(java.lang.String s, boolean escapeEntities, boolean trim) Replaces escapes in an XML resource string with the actual characters, performing unicode substitutions (replacing any \\uNNNN references in the given string with the corresponding unicode characters), etc.
static java.lang.String	unescapeResourceStringAsXml(java.lang.String xml) Unescapes a string resource value in compliance with the rules and this Android Cookbook recipe.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueXmlHelper

public ValueXmlHelper()

Method Detail

unescapeResourceString

@Contract(value="!null, _, _ -> !null")
 @Nullable
public static java.lang.String unescapeResourceString(@Nullable
                                                                                                         java.lang.String s,
                                                                                                         boolean escapeEntities,
                                                                                                         boolean trim)

Replaces escapes in an XML resource string with the actual characters, performing unicode substitutions (replacing any \\uNNNN references in the given string with the corresponding unicode characters), etc.

Parameters:

s - the string to unescape

escapeEntities - XML entities

trim - whether surrounding space and quotes should be trimmed

Returns:

the string with the escape characters removed and expanded

unescapeResourceStringAsXml

@NonNull
public static java.lang.String unescapeResourceStringAsXml(@NonNull
                                                                    java.lang.String xml)

Unescapes a string resource value in compliance with the rules and this Android Cookbook recipe.

The argument is expected to be valid XML. Character data outside of CDATA sections is unescaped as follows:

1. If the string starts with "\\?" or "\\@", that substring is unescaped
2. Unescaped quotation marks are stripped
3. "\\ ", "\\\"", "\\'", and "\\\\" are unescaped
4. "\\n" and "\\t" are unescaped to "\n" and "\t"

Throws:

java.lang.IllegalArgumentException - If the XML is not valid

escapeResourceString

@NonNull
public static java.lang.String escapeResourceString(@NonNull
                                                             java.lang.String string)

Escapes a string resource value in compliance with the rules and this Android Cookbook recipe.

The entire string is escaped as follows:

1. '"' and '\\' are escaped with backslashes
2. '\n' and '\t' are escaped with "\\n" and "\\t"
3. If the string starts or ends with a space, the string is quoted with '"'
4. If the string does not start or end with a space, '\'' is escaped with a backslash
5. If the string starts with a '?' or '@', that character is escaped with a backslash
6. '&' and '<' are escaped with "&" and "<"

If the string contains markup it will lose its semantics and become plain character data. If that is not desired, use escapeResourceStringAsXml(String) which is XML aware.

escapeResourceString

@NonNull
public static java.lang.String escapeResourceString(@NonNull
                                                             java.lang.String string,
                                                             boolean escapeMarkupDelimiters)

Escapes a string resource value in compliance with the rules and this Android Cookbook recipe.

The entire string is escaped as follows:

1. '"' and '\\' are escaped with backslashes
2. '\n' and '\t' are escaped with "\\n" and "\\t"
3. If the string starts or ends with a space, the string is quoted with '"'
4. If the string does not start or end with a space, '\'' is escaped with a backslash
5. If the string starts with a '?' or '@', that character is escaped with a backslash
6. If escapeMarkupDelimiters is true, '&' and '<' are escaped with "&" and "<"

If the string contains markup with attributes, the quotes will be escaped which will result in invalid XML. If escapeMarkupDelimiters is true, the markup will lose its semantics and become plain character data. If that is not desired, use escapeResourceStringAsXml(String) which is XML aware.

Parameters:

escapeMarkupDelimiters - if true escape '&' and '<' with their entity references

escapeResourceStringAsXml

@NonNull
public static java.lang.String escapeResourceStringAsXml(@NonNull
                                                                  java.lang.String xml)

Escapes a string resource value in compliance with the rules and this Android Cookbook recipe.

The argument is expected to be valid XML. Character data outside of CDATA sections is escaped as follows:

1. '"' and '\\' are escaped with backslashes
2. '\n' and '\t' are escaped with "\\n" and "\\t"
3. If the string starts or ends with a space, the string is quoted with '"'
4. If the string does not start or end with a space, '\'' is escaped with a backslash
5. If the string starts with a '?' or '@', that character is escaped with a backslash

Throws:

java.lang.IllegalArgumentException - If the XML is not valid