Package com.fasterxml.jackson.dataformat.xml.ser

Enum ToXmlGenerator.Feature

java.lang.Object
java.lang.Enum<ToXmlGenerator.Feature>
com.fasterxml.jackson.dataformat.xml.ser.ToXmlGenerator.Feature
All Implemented Interfaces:
FormatFeature, JacksonFeature, Serializable, Comparable<ToXmlGenerator.Feature>, java.lang.constant.Constable
Enclosing class:
ToXmlGenerator
public static enum ToXmlGenerator.Feature extends Enum<ToXmlGenerator.Feature> implements 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 Constants
    Enum Constant
    Description
    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.
    UNWRAP_ROOT_OBJECT_NODE
    Feature that determines writing of root values of type ObjectNode (JsonNode subtype that represents Object content values), regarding XML output.
    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.
    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.
    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_FLOATS
    Feature that determines how floating-point infinity values are serialized.

  • 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 ToXmlGenerator.Feature
    valueOf(String name)
    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.

    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

    • WRITE_XML_DECLARATION

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

      public static final ToXmlGenerator.Feature 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_NULLS_AS_XSI_NIL

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

      Feature is disabled by default for backwards compatibility.

      Since:
      2.10

    • UNWRAP_ROOT_OBJECT_NODE

      public static final ToXmlGenerator.Feature 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 disabled in Jackson 2.x, for backwards compatibility: likely to be changed in 3.0 to enabled.

      Since:
      2.13

    • AUTO_DETECT_XSI_TYPE

      public static final ToXmlGenerator.Feature 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
      Since:
      2.17

    • WRITE_XML_SCHEMA_CONFORMING_FLOATS

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

      Feature is disabled by default for backwards compatibility.

      Since:
      2.17

  • Method Details

    • values

      public static ToXmlGenerator.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 ToXmlGenerator.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