net.sf.practicalxml.converter.bean

Enum Xml2BeanOptions

java.lang.Object

java.lang.Enum<Xml2BeanOptions>

net.sf.practicalxml.converter.bean.Xml2BeanOptions

All Implemented Interfaces:

Serializable, Comparable<Xml2BeanOptions>

public enum Xml2BeanOptions
extends Enum<Xml2BeanOptions>

Options used by Xml2BeanConverter to control the way that DOM trees are translated to Java beans.

Since:

1.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
BYTE_ARRAYS_AS_BASE64 Expects byte arrays as a Base64-encoded string
BYTE_ARRAYS_AS_HEX Outputs byte arrays as a hex-encoded string
CACHE_INTROSPECTIONS Will use a shared static introspection cache for all conversions.
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).
DEFER_EXCEPTIONS Defer exception processing.
EMPTY_IS_NULL If present, the converter will treat all elements with empty text nodes as if they were empty elements -- in other words, null.
ENUM_AS_STRING_VALUE Match enums by their toString() values.
EXPECT_XSD_FORMAT Expect data (in particular, dates and booleans) to be formatted per XML Schema specifications.
IGNORE_MISSING_PROPERTIES If present, the converter ignores elements that don't correspond to settable properties of the bean.
REQUIRE_TYPE If present, the converter requires a type attribute on each element, and will use that attribute to verify that the element can be converted to the desired type.
REQUIRE_XSI_NIL If present, the converter requires an xsi:nil attribute on any empty nodes, and will throw if it's not present.

Method Summary

Methods

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

BYTE_ARRAYS_AS_BASE64

public static final Xml2BeanOptions BYTE_ARRAYS_AS_BASE64

Expects byte arrays as a Base64-encoded string

Since:

1.1.18

BYTE_ARRAYS_AS_HEX

public static final Xml2BeanOptions BYTE_ARRAYS_AS_HEX

Outputs byte arrays as a hex-encoded string

Since:

1.1.18

CACHE_INTROSPECTIONS

public static final Xml2BeanOptions CACHE_INTROSPECTIONS

Will use a shared static introspection cache for all conversions.

Warning: if you use this option, do not store this library in a shared app-server classpath. If you do, the cache will prevent class unloading, and you will run out of permgen space.

CONVERT_ATTRIBUTES

public static final Xml2BeanOptions 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.

Child elements will be converted after attributes; if an element has the same name as an attribute, the element value takes precedence.

CONVERT_ATTRIBUTES_MATCH_NAMESPACE

public static final Xml2BeanOptions 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).

Child elements will be converted after attributes; if an element has the same name as an attribute, the element value takes precedence.

DEFER_EXCEPTIONS

public static final Xml2BeanOptions DEFER_EXCEPTIONS

Defer exception processing. When an exception occurs during conversion, the node causing that exception is skipped and the exception is added to a list. The caller can then examine that list and take appropriate action.

Note: all deferred exceptions will be of type ConversionException, and will wrap an underlying cause. Because the converter works by reflection, in many cases this cause will be an InvocationTargetException with its own cause.

Since:

1.1.15

EMPTY_IS_NULL

public static final Xml2BeanOptions EMPTY_IS_NULL

If present, the converter will treat all elements with empty text nodes as if they were empty elements -- in other words, null. Note that this flag will interact with REQUIRE_XSI_NIL.

ENUM_AS_STRING_VALUE

public static final Xml2BeanOptions ENUM_AS_STRING_VALUE

Match enums by their toString() values. By default, enums are matched by name (which is also the default string value).

Since:

1.1.17

EXPECT_XSD_FORMAT

public static final Xml2BeanOptions EXPECT_XSD_FORMAT

Expect data (in particular, dates and booleans) to be formatted per XML Schema specifications.

IGNORE_MISSING_PROPERTIES

public static final Xml2BeanOptions IGNORE_MISSING_PROPERTIES

If present, the converter ignores elements that don't correspond to settable properties of the bean.

REQUIRE_TYPE

public static final Xml2BeanOptions REQUIRE_TYPE

If present, the converter requires a type attribute on each element, and will use that attribute to verify that the element can be converted to the desired type.

REQUIRE_XSI_NIL

public static final Xml2BeanOptions REQUIRE_XSI_NIL

If present, the converter requires an xsi:nil attribute on any empty nodes, and will throw if it's not present. Default is to treat empty nodes as null.

Method Detail

values

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

Returns:

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

valueOf

public static Xml2BeanOptions 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