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

Annotation Interface JacksonXmlElementWrapper

@Target({ANNOTATION_TYPE,FIELD,METHOD,PARAMETER}) @Retention(RUNTIME) public @interface JacksonXmlElementWrapper
Annotation that is similar to JAXB jakarta.xml.bind.annotation.XmlElementWrapper, to indicate wrapper element to use (if any) for Collection types (arrays, Collection). If defined, a separate container (wrapper) element is used; if not, entries are written with wrapping.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    localName
     
    String
    namespace
     
    boolean
    useWrapping
    Optional property that can be used to explicitly disable wrapping, usually via mix-ins, or when using AnnotationIntrospector pairs.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    USE_PROPERTY_NAME
    Marker value (empty String) that denotes that the underlying property name should also be used as the wrapper name, effectively "doubling" start and end elements.

  • Field Details

    • USE_PROPERTY_NAME

      static final String USE_PROPERTY_NAME
      Marker value (empty String) that denotes that the underlying property name should also be used as the wrapper name, effectively "doubling" start and end elements.
      See Also:

  • Element Details

    • namespace

      String namespace
      Default:
      ""

    • localName

      String localName
      Default:
      ""

    • useWrapping

      boolean useWrapping
      Optional property that can be used to explicitly disable wrapping, usually via mix-ins, or when using AnnotationIntrospector pairs.
      Default:
      true