Module dev.metaschema.databind
Package dev.metaschema.databind.model.annotations

Annotation Type GroupAs

@Documented @Retention(RUNTIME) @Target(ANNOTATION_TYPE) public @interface GroupAs
Defines how a collection of model instances should be grouped.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    The name to use for an XML grouping element wrapper or a JSON/YAML grouping property.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    JsonGroupAsBehavior
    inJson
    Describes how to handle collections in JSON/YAML.
    XmlGroupAsBehavior
    inXml
    Describes how to handle collections in XML.

  • Element Details

    • name

      @NonNull String name
      The name to use for an XML grouping element wrapper or a JSON/YAML grouping property.
      Returns:
      the name

    • inJson

      @NonNull JsonGroupAsBehavior inJson
      Describes how to handle collections in JSON/YAML.
      Returns:
      the JSON collection strategy
      Default:
      SINGLETON_OR_LIST

    • inXml

      @NonNull XmlGroupAsBehavior inXml
      Describes how to handle collections in XML.
      Returns:
      the XML collection strategy
      Default:
      UNGROUPED