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

Annotation Type BoundAssembly

@Documented @Retention(RUNTIME) @Target({FIELD,METHOD,ANNOTATION_TYPE}) public @interface BoundAssembly
Identifies that the annotation target is a bound property that references a Module assembly.

For XML serialization, the useName() identifies the name of the element to use for this element.

For JSON and YAML serializations, the useName() identifies the property/item name to use.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    Get the documentary description of the assembly.
    String
    formalName
    Get the documentary formal name of the assembly.
    GroupAs
    groupAs
    Used to provide grouping information.
    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.
    Property[]
    properties
    An optional set of associated properties.
    String
    remarks
    Get any remarks for this field.
    int
    useIndex
    The binary use name of the assembly.
    String
    useName
    The model name to use for singleton values.

  • Element Details

    • formalName

      @NonNull String formalName
      Get the documentary formal name of the assembly.

      If the value is "##none", then the description will be considered null.

      Returns:
      a markdown string or "##none" if no formal name is provided
      Default:
      "##none"

    • description

      @NonNull String description
      Get the documentary description of the assembly.

      If the value is "##none", then the description will be considered null.

      Returns:
      a markdown string or "##none" if no description is provided
      Default:
      "##none"

    • useName

      @NonNull String useName
      The model name to use for singleton values. This name will be used for associated XML elements.

      If the value is "##none", then element name is derived from the JavaBean property name.

      Returns:
      the name or "##none" if no use name is provided
      Default:
      "##none"

    • useIndex

      int useIndex
      The binary use name of the assembly.

      The value Integer.MIN_VALUE indicates that there is no use name.

      Returns:
      the index value
      Default:
      -2147483648

    • 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

    • properties

      Property[] properties
      An optional set of associated properties.
      Returns:
      the properties or an empty array with no properties
      Default:
      {}

    • remarks

      @NonNull String remarks
      Get any remarks for this field.
      Returns:
      a markdown string or "##none" if no remarks are provided
      Default:
      "##none"

    • 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")