Module gov.nist.secauto.metaschema.databind
Package gov.nist.secauto.metaschema.databind.model.annotations

Annotation Type BoundChoiceGroup

@Documented @Retention(RUNTIME) @Target({FIELD,METHOD}) public @interface BoundChoiceGroup
Identifies that the annotation target is a bound property that references a collection of model instances of varying types.

For JSON and YAML serializations, the discriminator() identifies the property use to differentiate the type of object values.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    BoundGroupedAssembly[]
    assemblies
    The the assemblies that may occur within this choice group.
    String
    discriminator
    The discriminator to use for determining the type of child elements in JSON.
    BoundGroupedField[]
    fields
    The the fields that may occur within this choice group.
    GroupAs
    groupAs
    Used to provide grouping information.
    String
    jsonKey
    The name of a common flag to use as the JSON key that appears on all associated assemblies() and fields().
    int
    maxOccurs
    A number that indicates the maximum occurrence of the model instance.
    int
    minOccurs
    A non-negative number that indicates the minimum occurrence of the model instance.

  • Element Details

    • discriminator

      @NonNull String discriminator
      The discriminator to use for determining the type of child elements in JSON.
      Returns:
      the discriminator property name
      Default:
      "object-type"

    • minOccurs

      int minOccurs
      A non-negative number that indicates the minimum occurrence of the model instance.
      Returns:
      a non-negative number
      Default:
      0

    • maxOccurs

      int maxOccurs
      A number that indicates the maximum occurrence of the model instance.
      Returns:
      a positive number or -1 to indicate "unbounded"
      Default:
      1

    • groupAs

      @NonNull GroupAs groupAs
      Used to provide grouping information.

      This annotation is required when the value of maxOccurs() is greater than 1.

      Returns:
      the configured GroupAs or the default value with a null GroupAs.name()
      Default:
      @gov.nist.secauto.metaschema.databind.model.annotations.GroupAs(name="\u0000")

    • jsonKey

      @NonNull String jsonKey
      The name of a common flag to use as the JSON key that appears on all associated assemblies() and fields().
      Returns:
      the configured JSON key flag name or ModelUtil.NO_STRING_VALUE if no JSON key is configured
      Default:
      "##none"

    • assemblies

      @NonNull BoundGroupedAssembly[] assemblies
      The the assemblies that may occur within this choice group.
      Returns:
      an array of assembly bindings which may occur within this choice group
      Default:
      {}

    • fields

      @NonNull BoundGroupedField[] fields
      The the fields that may occur within this choice group.
      Returns:
      an array of field bindings which may occur within this choice group
      Default:
      {}