freemarker.template.utility

Enum StringUtil.JsStringEncCompatibility

java.lang.Object

java.lang.Enum<StringUtil.JsStringEncCompatibility>

freemarker.template.utility.StringUtil.JsStringEncCompatibility

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StringUtil.JsStringEncCompatibility>

Enclosing class:

StringUtil

public static enum StringUtil.JsStringEncCompatibility
extends java.lang.Enum<StringUtil.JsStringEncCompatibility>

Used as the argument of StringUtil.jsStringEnc(String, JsStringEncCompatibility, JsStringEncQuotation).

Since:

2.3.32

Enum Constant Summary

Enum Constants

Enum Constant and Description
JAVA_SCRIPT Output is expected to be used in JavaScript, not in JSON.
JAVA_SCRIPT_OR_JSON Output is expected to be used both in JSON and JavaScript.
JSON Output is expected to be used in JSON, not in JavaScript.

Method Summary

Modifier and Type	Method and Description
static StringUtil.JsStringEncCompatibility	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StringUtil.JsStringEncCompatibility[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JAVA_SCRIPT

public static final StringUtil.JsStringEncCompatibility JAVA_SCRIPT

Output is expected to be used in JavaScript, not in JSON.

JSON

public static final StringUtil.JsStringEncCompatibility JSON

Output is expected to be used in JSON, not in JavaScript. While JSON is compatible with JavaScript, in this mode we don't care about escaping apostrophe, as it's not special in JSON.

JAVA_SCRIPT_OR_JSON

public static final StringUtil.JsStringEncCompatibility JAVA_SCRIPT_OR_JSON

Output is expected to be used both in JSON and JavaScript.

Method Detail

values

public static StringUtil.JsStringEncCompatibility[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StringUtil.JsStringEncCompatibility c : StringUtil.JsStringEncCompatibility.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StringUtil.JsStringEncCompatibility valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null