net.sf.practicalxml.converter.bean

Enum Bean2XmlOptions

java.lang.Object

java.lang.Enum<Bean2XmlOptions>

net.sf.practicalxml.converter.bean.Bean2XmlOptions

All Implemented Interfaces:

Serializable, Comparable<Bean2XmlOptions>

public enum Bean2XmlOptions
extends Enum<Bean2XmlOptions>

Options used by Bean2XmlConverter to control the structure of the generated DOM tree.

Since:

1.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
BYTE_ARRAYS_AS_BASE64 Outputs 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.
DEFER_EXCEPTIONS Defer exception processing.
ENUM_AS_NAME_AND_VALUE Output enum instances with an attribute containing the enum's name, and the text value containing the enum's toString().
MAP_KEYS_AS_ELEMENT_NAME Output maps in an "introspected" format, where the name of each item is the map key (rather than "data"), and the "key" attribute is omitted.
NULL_AS_EMPTY If the value is null, add an element containing a single text child holding an empty string.
NULL_AS_XSI_NIL If the value is null, add an element without content, with the attribute xsi:nil set to "true".
SEQUENCE_AS_REPEATED_ELEMENTS Will create sequences (arrays, lists, and sets) as repeated elements rather than a parent-children construct.
SEQUENCE_NAMED_BY_PARENT Sequences (arrays, lists, sets) will name their elements according to the parent element, with any trailing "s" removed.
SET_ACCESSIBLE When introspecting, call setAccessible(true) on accessor methods.
SKIP_CIRCULAR_REFERENCES Omits circular references from the output.
USE_INDEX_ATTR Will add an index attribute to the child elements of sequences (arrays, lists, sets); the value of this attribute is the element's position in the sequence (numbered from 0).
USE_TYPE_ATTR Will add a type attribute to each element; see package docs for more details.
XSD_FORMAT Outputs values using formats defined by XML Schema, rather than Java's String.valueOf() method.

Method Summary

Methods

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

Outputs byte arrays as a Base64-encoded string

Since:

1.1.18

BYTE_ARRAYS_AS_HEX

public static final Bean2XmlOptions BYTE_ARRAYS_AS_HEX

Outputs byte arrays as a hex-encoded string

Since:

1.1.18

CACHE_INTROSPECTIONS

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

DEFER_EXCEPTIONS

public static final Bean2XmlOptions 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

ENUM_AS_NAME_AND_VALUE

public static final Bean2XmlOptions ENUM_AS_NAME_AND_VALUE

Output enum instances with an attribute containing the enum's name, and the text value containing the enum's toString(). Default is to output the enum's name as the element value.

This option is useful when the enum contains descriptive text, and you want to use that text in further output.

Since:

1.1.17

MAP_KEYS_AS_ELEMENT_NAME

public static final Bean2XmlOptions MAP_KEYS_AS_ELEMENT_NAME

Output maps in an "introspected" format, where the name of each item is the map key (rather than "data"), and the "key" attribute is omitted. If any key is not a valid XML identifier, the converter will throw.

NULL_AS_EMPTY

public static final Bean2XmlOptions NULL_AS_EMPTY

If the value is null, add an element containing a single text child holding an empty string.

This may make life easier when processing data from a certain DBMS designed in the mid-1980s when disk space was too expensive to create a separate null flag for VARCHAR fields. However, be aware that it may cause parsing problems.

NULL_AS_XSI_NIL

public static final Bean2XmlOptions NULL_AS_XSI_NIL

If the value is null, add an element without content, with the attribute xsi:nil set to "true".

SEQUENCE_AS_REPEATED_ELEMENTS

public static final Bean2XmlOptions SEQUENCE_AS_REPEATED_ELEMENTS

Will create sequences (arrays, lists, and sets) as repeated elements rather than a parent-children construct. This option is invalid when converting an array as the top-level object, as it would cause the creation of multiple root elements. It also produces output that can not, at this time, be processed correctly by Xml2BeanConverter.

SET_ACCESSIBLE

public static final Bean2XmlOptions SET_ACCESSIBLE

When introspecting, call setAccessible(true) on accessor methods. This allows use with instances of private classes that have public methods, but will cause an exception in any environment that has a security manager that denies this operation.

Since:

1.1.15

SKIP_CIRCULAR_REFERENCES

public static final Bean2XmlOptions SKIP_CIRCULAR_REFERENCES

Omits circular references from the output. By default, the converter will throw if it discovers a circular reference. When this option is in effect, it simply skips over the reference. This is useful when converting objects managed by an ORM, where you normally don't care about backlinks.

Since:

1.1.14

SEQUENCE_NAMED_BY_PARENT

public static final Bean2XmlOptions SEQUENCE_NAMED_BY_PARENT

Sequences (arrays, lists, sets) will name their elements according to the parent element, with any trailing "s" removed. For example, if the parent is named "products", each child will be named "product", rather than the default "data". If the parent is named "foo", each child will also be named "foo" (since there's no "s" to remove).

USE_INDEX_ATTR

public static final Bean2XmlOptions USE_INDEX_ATTR

Will add an index attribute to the child elements of sequences (arrays, lists, sets); the value of this attribute is the element's position in the sequence (numbered from 0). This index is not terribly useful, so is no longer default behavior.

USE_TYPE_ATTR

public static final Bean2XmlOptions USE_TYPE_ATTR

Will add a type attribute to each element; see package docs for more details.

This option implies XSD_FORMAT.

XSD_FORMAT

public static final Bean2XmlOptions XSD_FORMAT

Outputs values using formats defined by XML Schema, rather than Java's String.valueOf() method. Note that these formats are not flagged in the element, so sender and receiver will have to agree on the format.

Method Detail

values

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

Returns:

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

valueOf

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