Enum FromXmlParser.Feature
- java.lang.Object
-
- java.lang.Enum<FromXmlParser.Feature>
-
- com.fasterxml.jackson.dataformat.xml.deser.FromXmlParser.Feature
-
- All Implemented Interfaces:
FormatFeature
,JacksonFeature
,java.io.Serializable
,java.lang.Comparable<FromXmlParser.Feature>
- Enclosing class:
- FromXmlParser
public static enum FromXmlParser.Feature extends java.lang.Enum<FromXmlParser.Feature> implements FormatFeature
Enumeration that defines all togglable features for XML parsers.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description 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 asJsonToken.VALUE_NULL
) or not.PROCESS_XSI_NIL
Feature that indicates whether XML Schema Instance attributexsi:nil
will be processed automatically -- to indicatenull
values -- or not.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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 bitmaskint
getMask()
Returns bit mask for this feature instance; must be a single bit, that is of form(1 << N)
static FromXmlParser.Feature
valueOf(java.lang.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.
-
-
-
Enum Constant Detail
-
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 asJsonToken.VALUE_NULL
) or not. If they are not returned as `null` tokens, they will be returned asJsonToken.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 befalse
(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 attributexsi:nil
will be processed automatically -- to indicatenull
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 Detail
-
values
public static FromXmlParser.Feature[] 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 (FromXmlParser.Feature c : FromXmlParser.Feature.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FromXmlParser.Feature valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.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 interfaceFormatFeature
- Specified by:
enabledByDefault
in interfaceJacksonFeature
- 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 interfaceFormatFeature
- Specified by:
getMask
in interfaceJacksonFeature
- 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 interfaceFormatFeature
- Specified by:
enabledIn
in interfaceJacksonFeature
- 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
-
-