Enum ToXmlGenerator.Feature
java.lang.Object
java.lang.Enum<ToXmlGenerator.Feature>
com.fasterxml.jackson.dataformat.xml.ser.ToXmlGenerator.Feature
- All Implemented Interfaces:
com.fasterxml.jackson.core.FormatFeature
,com.fasterxml.jackson.core.util.JacksonFeature
,Serializable
,Comparable<ToXmlGenerator.Feature>
,java.lang.constant.Constable
- Enclosing class:
- ToXmlGenerator
public static enum ToXmlGenerator.Feature
extends Enum<ToXmlGenerator.Feature>
implements com.fasterxml.jackson.core.FormatFeature
Enumeration that defines all togglable extra XML-specific features
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionFeature that determines writing of root values of typeObjectNode
(JsonNode
subtype that represents Object content values), regarding XML output.Feature that controls whether serialization of Javanull
values adds XML attribute of `xsi:nil`, as defined by XML Schema (see this article for details) or not.Feature that controls whether output should be done as XML 1.1; if so, certain aspects may differ from default (1.0) processing: for example, XML declaration will be automatically added (regardless of settingWRITE_XML_DECLARATION
) as this is required for reader to know to use 1.1 compliant handling.Feature that controls whether XML declaration should be written before when generator is initialized (true) or not (false) -
Field Summary
FieldsModifier and TypeFieldDescription(package private) final boolean
(package private) final int
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic int
Method that calculates bit set (flags) of all features that are enabled by default.boolean
boolean
enabledIn
(int flags) int
getMask()
static ToXmlGenerator.Feature
Returns the enum constant of this type with the specified name.static ToXmlGenerator.Feature[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
WRITE_XML_DECLARATION
Feature that controls whether XML declaration should be written before when generator is initialized (true) or not (false) -
WRITE_XML_1_1
Feature that controls whether output should be done as XML 1.1; if so, certain aspects may differ from default (1.0) processing: for example, XML declaration will be automatically added (regardless of settingWRITE_XML_DECLARATION
) as this is required for reader to know to use 1.1 compliant handling. XML 1.1 can be used to allow quoted control characters (Ascii codes 0 through 31) as well as additional linefeeds and name characters. -
WRITE_NULLS_AS_XSI_NIL
Feature that controls whether serialization of Javanull
values adds XML attribute of `xsi:nil`, as defined by XML Schema (see this article for details) or not. If enabled, `xsi:nil` attribute will be added to the empty element; if disabled, it will not.Feature is disabled by default for backwards compatibility.
- Since:
- 2.10
-
UNWRAP_ROOT_OBJECT_NODE
Feature that determines writing of root values of typeObjectNode
(JsonNode
subtype that represents Object content values), regarding XML output. If enabled andObjectNode
has exactly one entry (key/value pair), then key of that entry is used as the root element name (and value is written as contents. Otherwise (if feature disabled, or if rootObjectNode
has any other number of key/value entries, root element name is determined using normal logic (either explicitly configured, orObjectNode
otherwise).Default setting is
disabled
in Jackson 2.x, for backwards compatibility: likely to be changed in 3.0 toenabled
.- Since:
- 2.13
-
-
Field Details
-
_defaultState
final boolean _defaultState -
_mask
final int _mask
-
-
Constructor Details
-
Feature
private Feature(boolean defaultState)
-
-
Method Details
-
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
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 nameNullPointerException
- 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 interfacecom.fasterxml.jackson.core.FormatFeature
- Specified by:
enabledByDefault
in interfacecom.fasterxml.jackson.core.util.JacksonFeature
-
getMask
public int getMask()- Specified by:
getMask
in interfacecom.fasterxml.jackson.core.FormatFeature
- Specified by:
getMask
in interfacecom.fasterxml.jackson.core.util.JacksonFeature
-
enabledIn
public boolean enabledIn(int flags) - Specified by:
enabledIn
in interfacecom.fasterxml.jackson.core.FormatFeature
- Specified by:
enabledIn
in interfacecom.fasterxml.jackson.core.util.JacksonFeature
-