Package com.fasterxml.jackson.dataformat.xml.deser

Enum FromXmlParser.Feature

java.lang.Object

java.lang.Enum<FromXmlParser.Feature>

com.fasterxml.jackson.dataformat.xml.deser.FromXmlParser.Feature

All Implemented Interfaces:

FormatFeature, JacksonFeature, Serializable, Comparable<FromXmlParser.Feature>, java.lang.constant.Constable

Enclosing class:

FromXmlParser

public static enum FromXmlParser.Feature
extends Enum<FromXmlParser.Feature>
implements FormatFeature

Enumeration that defines all togglable features for XML parsers.

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 XML Empty elements (ones where there are no separate start and end tags, but just one tag that ends with "/>") 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()	Accessor for checking whether this feature is enabled by default.
boolean	enabledIn(int flags)	Convenience method for checking whether feature is enabled in given bitmask
int	getMask()	Returns bit mask for this feature instance; must be a single bit, that is of form (1 << N)
static FromXmlParser.Feature	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FromXmlParser.Feature[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, 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 FromXmlParser.Feature 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.

Since:

2.17

EMPTY_ELEMENT_AS_NULL

public static final FromXmlParser.Feature EMPTY_ELEMENT_AS_NULL

Feature that indicates whether XML Empty elements (ones where there are no separate start and end tags, but just one tag that ends with "/>") 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).

Default setting was true (for backwards compatibility from 2.9 to 2.11 (inclusive) but was changed in 2.12 to be false (see [dataformat-xml#411] for details)

Since:

2.9

PROCESS_XSI_NIL

public static final FromXmlParser.Feature 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 since processing was enabled in 2.12.

Since:

2.13

Method Details

values

public static FromXmlParser.Feature[] values()

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

Returns:

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

valueOf

public static FromXmlParser.Feature 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

collectDefaults

public static int collectDefaults()

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

enabledByDefault

public boolean enabledByDefault()

Description copied from interface: FormatFeature

Accessor for checking whether this feature is enabled by default.

Specified by:

enabledByDefault in interface FormatFeature

Specified by:

enabledByDefault in interface JacksonFeature

Returns:

Whether this instance is enabled by default or not

getMask

public int getMask()

Description copied from interface: FormatFeature

Returns bit mask for this feature instance; must be a single bit, that is of form (1 << N)

Specified by:

getMask in interface FormatFeature

Specified by:

getMask in interface JacksonFeature

Returns:

Bit mask of this feature

enabledIn

public boolean enabledIn(int flags)

Description copied from interface: FormatFeature

Convenience method for checking whether feature is enabled in given bitmask

Specified by:

enabledIn in interface FormatFeature

Specified by:

enabledIn in interface JacksonFeature

Parameters:

flags - Bit field that contains a set of enabled features of this type

Returns:

True if this feature is enabled in passed bit field