Module tools.jackson.dataformat.xml
Package tools.jackson.dataformat.xml.annotation

Annotation Interface JacksonXmlRootElement

@Target({ANNOTATION_TYPE,TYPE}) @Retention(RUNTIME) @Deprecated public @interface JacksonXmlRootElement
Deprecated.
Since 3.0 use JsonRootName instead
Annotation that can be used to define name of root element used for the root-level object when serialized, which normally uses name of the type (class). It is similar to JAXB XmlRootElement and basically an alias for standard Jackson annotation JsonRootName (which you should usually use instead).

Note that annotation has no effect on non-root elements: regular property values and so on; their name is derived from getter/setter/field, not from type itself.

NOTE! Since 2.4 this annotation is usually not necessary and you should use JsonRootName instead. About the only expected usage may be to have different root name for XML content than other formats.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    localName
    Deprecated.
     
    String
    namespace
    Deprecated.
     

  • Element Details

    • namespace

      String namespace
      Deprecated.
      Default:
      ""

    • localName

      String localName
      Deprecated.
      Default:
      ""