net.sf.practicalxml.converter.json

Enum Xml2JsonOptions

java.lang.Object

java.lang.Enum<Xml2JsonOptions>

net.sf.practicalxml.converter.json.Xml2JsonOptions

All Implemented Interfaces:

Serializable, Comparable<Xml2JsonOptions>

public enum Xml2JsonOptions
extends Enum<Xml2JsonOptions>

Options to control conversion from XML documents to JSON strings.

Since:

1.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONVERT_ATTRIBUTES Will attempt to convert attribute values as well as elements.
CONVERT_ATTRIBUTES_MATCH_NAMESPACE Will attempt to convert attribute values as well as elements, ignoring all attributes that do not have the same namespace as the element they belong to (includes null namespaces).
UNQUOTED_FIELD_NAMES If enabled, field names will not be quoted.
USE_XSI_TYPE If enabled, the converter will look for an xsi:type attribute (type in XML Schema Instance namespace), and apply the following rules: If the attribute value begins with "xsd:", and the portion after the ":" is one of the XSD primitive numeric or boolean types, the element's value will be emitted without quotes.
WRAP_WITH_PARENS If enabled, the entire string is wrapped by parentheses.

Method Summary

Methods

Modifier and Type	Method and Description
static Xml2JsonOptions	valueOf(String name) Returns the enum constant of this type with the specified name.
static Xml2JsonOptions[]	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

CONVERT_ATTRIBUTES

public static final Xml2JsonOptions CONVERT_ATTRIBUTES

Will attempt to convert attribute values as well as elements. Will not convert attributes with XML Schema Instance namespace or the converter's own namespace, but otherwise ignores namespace.

Attributes are converted as if they were child elements, but will appear in the output before any children. The order of attributes is undefined (per XML spec).

Warning:: If an attribute has the same name as a child element, both will be emitted in the output. When that JSON is then processed by JavaScript, the second value will overwrite the first (although ugly, this behavior is consistent with the other converters).

If an element has attributes but no children, the element's text content (if any) will be ignored.

If the attribute has a namespace prefix, that prefix will be dropped in the output (it is an invalid JSON fieldname). If multiple attributes have the same local name but different prefixes, they will all be emitted in the output (but only one will surving being read back in).

CONVERT_ATTRIBUTES_MATCH_NAMESPACE

public static final Xml2JsonOptions CONVERT_ATTRIBUTES_MATCH_NAMESPACE

Will attempt to convert attribute values as well as elements, ignoring all attributes that do not have the same namespace as the element they belong to (includes null namespaces).

See CONVERT_ATTRIBUTES for additional rules and caveats.

UNQUOTED_FIELD_NAMES

public static final Xml2JsonOptions UNQUOTED_FIELD_NAMES

If enabled, field names will not be quoted. This violates the JSON spec, which defines the production "pair" as "string : value" (and "string" is quoted). However, literal Java objects do not quote the field names, so if you use this converter to create explicit scripts, you won't want to follow the spec (and, not surprisingly, eval() doesn't require quoted names either).

USE_XSI_TYPE

public static final Xml2JsonOptions USE_XSI_TYPE

If enabled, the converter will look for an xsi:type attribute (type in XML Schema Instance namespace), and apply the following rules:

• If the attribute value begins with "xsd:", and the portion after the ":" is one of the XSD primitive numeric or boolean types, the element's value will be emitted without quotes.
• If the attribute value begins with "java:", and the portion after the ":" corresponds to a Java array type or standard collection type, then the element's content will be emitted as a JSON array (assumes zero or more sub-elements).

These rules are designed to allow use of XML produced by BeanConverter, preserving knowledge about the bean structure.

WRAP_WITH_PARENS

public static final Xml2JsonOptions WRAP_WITH_PARENS

If enabled, the entire string is wrapped by parentheses. This is needed for strings that will be passed to eval(). Note that the resulting string is not acceptable to Json2XmlConverter.

Method Detail

values

public static Xml2JsonOptions[] 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 (Xml2JsonOptions c : Xml2JsonOptions.values())
    System.out.println(c);

Returns:

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

valueOf

public static Xml2JsonOptions valueOf(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:

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

NullPointerException - if the argument is null