Module tools.jackson.dataformat.xml

Package tools.jackson.dataformat.xml

Enum Class XmlReadFeature

java.lang.Object

java.lang.Enum<XmlReadFeature>

tools.jackson.dataformat.xml.XmlReadFeature

All Implemented Interfaces:

Serializable, Comparable<XmlReadFeature>, Constable, tools.jackson.core.FormatFeature, tools.jackson.core.util.JacksonFeature

public enum XmlReadFeature
extends Enum<XmlReadFeature>
implements tools.jackson.core.FormatFeature

Enumeration that defines all togglable features for XML parsers.

NOTE: in Jackson 2.x this was named FromXmlParser.Feature.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO_DETECT_XSI_TYPE	Feature that enables automatic conversion of incoming "xsi:type" (where "type" is the local name and "xsi" prefix is bound to URI XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI), into Jackson simple Property Name of "xsi:type".
EMPTY_ELEMENT_AS_NULL	Feature that indicates whether empty XML elements (both empty tags like <tag /> and <tag></tag> (with no intervening cdata) are exposed as JsonToken.VALUE_NULL) or not.
PROCESS_XSI_NIL	Feature that indicates whether XML Schema Instance attribute xsi:nil will be processed automatically -- to indicate null values -- or not.

Method Summary

Modifier and Type	Method	Description
static int	collectDefaults()	Method that calculates bit set (flags) of all features that are enabled by default.
boolean	enabledByDefault()
boolean	enabledIn(int flags)
int	getMask()
static XmlReadFeature	valueOf(String name)	Returns the enum constant of this class with the specified name.
static XmlReadFeature[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUTO_DETECT_XSI_TYPE

public static final XmlReadFeature AUTO_DETECT_XSI_TYPE

Feature that enables automatic conversion of incoming "xsi:type" (where "type" is the local name and "xsi" prefix is bound to URI XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI), into Jackson simple Property Name of "xsi:type". This is usually needed to read content written using matching ToXmlGenerator.Feature#AUTO_DETECT_XSI_TYPE feature, usually used for Polymorphic handling where it is difficult to specify proper XML Namespace for type identifier.

Default setting is true (was false in Jackson 2.x).

EMPTY_ELEMENT_AS_NULL

public static final XmlReadFeature EMPTY_ELEMENT_AS_NULL

Feature that indicates whether empty XML elements (both empty tags like <tag /> and <tag></tag> (with no intervening cdata) are exposed as JsonToken.VALUE_NULL) or not. If they are not returned as `null` tokens, they will be returned as JsonToken.VALUE_STRING tokens with textual value of "" (empty String).

NOTE: in Jackson 2.x, only "true" empty tags were affected, not split ones. With 3.x both cases handled uniformly.

Default setting is false.

PROCESS_XSI_NIL

public static final XmlReadFeature PROCESS_XSI_NIL

Feature that indicates whether XML Schema Instance attribute xsi:nil will be processed automatically -- to indicate null values -- or not. If enabled, xsi:nil attribute on any XML element will mark such elements as "null values" and any other attributes or child elements they might have to be ignored. If disabled this attribute will be exposed like any other attribute.

Default setting is true.

Method Details

values

public static XmlReadFeature[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static XmlReadFeature valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

collectDefaults

public static int collectDefaults()

Method that calculates bit set (flags) of all features that are enabled by default.

enabledByDefault

public boolean enabledByDefault()

Specified by:

enabledByDefault in interface tools.jackson.core.util.JacksonFeature

getMask

public int getMask()

Specified by:

getMask in interface tools.jackson.core.util.JacksonFeature

enabledIn

public boolean enabledIn(int flags)

Specified by:

enabledIn in interface tools.jackson.core.util.JacksonFeature