Top Description Fields Constructors Methods
tools.jackson.dataformat.xml

public final Enum XmlWriteFeature

extends Enum<XmlWriteFeature>
implements FormatFeature
Class Inheritance
All Implemented Interfaces
tools.jackson.core.FormatFeature, tools.jackson.core.util.JacksonFeature
Imports
javax.xml.XMLConstants, tools.jackson.core.FormatFeature

Enumeration that defines all togglable extra XML-specific features.

Note

in Jackson 2.x this was named ToXmlGenerator.Feature.

Field Summary

Modifier and TypeField and Description
private final boolean
private final int
public static final XmlWriteFeature
AUTO_DETECT_XSI_TYPE

Feature that enables automatic conversion of logical property name "xsi:type" into matching XML name where "type" is the local name and "xsi" prefix is bound to URI XMLConstants#W3C_XML_SCHEMA_INSTANCE_NS_URI, and output is indicated to be done as XML Attribute.

public static final XmlWriteFeature
UNWRAP_ROOT_OBJECT_NODE

Feature that determines writing of root values of type ObjectNode (JsonNode subtype that represents Object content values), regarding XML output.

public static final XmlWriteFeature
WRITE_NULLS_AS_XSI_NIL

Feature that controls whether serialization of Java null values adds XML attribute of `xsi:nil`, as defined by XML Schema (see this article for details) or not.

public static final XmlWriteFeature
WRITE_STANDALONE_YES_TO_XML_DECLARATION

Feature that controls whether XML declaration should include the standalone attribute when generator is initialized (true) or not (false).

public static final XmlWriteFeature
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 setting WRITE_XML_DECLARATION) as this is required for reader to know to use 1.1 compliant handling.

public static final XmlWriteFeature
WRITE_XML_DECLARATION

Feature that controls whether XML declaration should be written before when generator is initialized (true) or not (false)

public static final XmlWriteFeature
WRITE_XML_SCHEMA_CONFORMING_FLOATS

Feature that determines how floating-point infinity values are serialized.

Constructor Summary

AccessConstructor and Description
private
XmlWriteFeature(boolean defaultState)

Method Summary

Modifier and TypeMethod and Description
public static int
collectDefaults()

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

public boolean
enabledByDefault()

Implements tools.jackson.core.util.JacksonFeature.enabledByDefault.

Accessor for checking whether this feature is enabled by default.

public boolean
enabledIn(int flags)

Implements tools.jackson.core.util.JacksonFeature.enabledIn.

Convenience method for checking whether feature is enabled in given bitmask.

public int
getMask()

Implements tools.jackson.core.util.JacksonFeature.getMask.

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

public static XmlWriteFeature
public static XmlWriteFeature[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

_defaultStateback to summary
private final boolean _defaultState
_maskback to summary
private final int _mask
AUTO_DETECT_XSI_TYPEback to summary
public static final XmlWriteFeature AUTO_DETECT_XSI_TYPE

Feature that enables automatic conversion of logical property name "xsi:type" into matching XML name where "type" is the local name and "xsi" prefix is bound to URI XMLConstants#W3C_XML_SCHEMA_INSTANCE_NS_URI, and output is indicated to be done as XML Attribute. This is mostly desirable for Polymorphic handling where it is difficult to specify XML Namespace for type identifier

Default setting is true (enabled) in Jackson 3.0: it was false (disabled)in Jackson 2.x.

UNWRAP_ROOT_OBJECT_NODEback to summary
public static final XmlWriteFeature UNWRAP_ROOT_OBJECT_NODE

Feature that determines writing of root values of type ObjectNode (JsonNode subtype that represents Object content values), regarding XML output. If enabled and ObjectNode 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 root ObjectNode has any other number of key/value entries, root element name is determined using normal logic (either explicitly configured, or ObjectNode otherwise).

Default setting is true (enabled) in Jackson 3.x: it was false (disabled)in Jackson 2.x.

WRITE_NULLS_AS_XSI_NILback to summary
public static final XmlWriteFeature WRITE_NULLS_AS_XSI_NIL

Feature that controls whether serialization of Java null 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.

Default setting is true (enabled) in Jackson 3.x: it was false (disabled)in Jackson 2.x.

WRITE_STANDALONE_YES_TO_XML_DECLARATIONback to summary
public static final XmlWriteFeature WRITE_STANDALONE_YES_TO_XML_DECLARATION

Feature that controls whether XML declaration should include the standalone attribute when generator is initialized (true) or not (false). Only honored when WRITE_XML_DECLARATION is enabled

WRITE_XML_1_1back to summary
public static final XmlWriteFeature 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 setting WRITE_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_XML_DECLARATIONback to summary
public static final XmlWriteFeature WRITE_XML_DECLARATION

Feature that controls whether XML declaration should be written before when generator is initialized (true) or not (false)

WRITE_XML_SCHEMA_CONFORMING_FLOATSback to summary
public static final XmlWriteFeature WRITE_XML_SCHEMA_CONFORMING_FLOATS

Feature that determines how floating-point infinity values are serialized.

By default, Float#POSITIVE_INFINITY and Double#POSITIVE_INFINITY are serialized as Infinity, and Float#NEGATIVE_INFINITY and Double#NEGATIVE_INFINITY are serialized as -Infinity. This is the representation that Java normally uses for these values (see Float#toString(float) and Double#toString(double)), but JAXB and other XML Schema-conforming readers won't understand it.

With this feature enabled, these values are instead serialized as INF and -INF, respectively. This is the representation that XML Schema and JAXB use (see the XML Schema primitive types float and double).

When deserializing, Jackson always understands both representations, so there is no corresponding tools.jackson.dataformat.xml.XmlReadFeature.

Default setting is true (enabled) in Jackson 3.0: it was false (disabled)in Jackson 2.x.

Constructor Detail

XmlWriteFeatureback to summary
private XmlWriteFeature(boolean defaultState)

Method Detail

collectDefaultsback to summary
public static int collectDefaults()

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

enabledByDefaultback to summary
public boolean enabledByDefault()

Implements tools.jackson.core.util.JacksonFeature.enabledByDefault.

Doc from tools.jackson.core.util.JacksonFeature.enabledByDefault.

Accessor for checking whether this feature is enabled by default.

Annotations
@Override
enabledInback to summary
public boolean enabledIn(int flags)

Implements tools.jackson.core.util.JacksonFeature.enabledIn.

Doc from tools.jackson.core.util.JacksonFeature.enabledIn.

Convenience method for checking whether feature is enabled in given bitmask.

Annotations
@Override
getMaskback to summary
public int getMask()

Implements tools.jackson.core.util.JacksonFeature.getMask.

Doc from tools.jackson.core.util.JacksonFeature.getMask.

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

Annotations
@Override
valueOfback to summary
public static XmlWriteFeature valueOf(String name)
valuesback to summary
public static XmlWriteFeature[] values()