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

Annotation Type MetaschemaField

@Documented @Retention(RUNTIME) @Target(TYPE) public @interface MetaschemaField
This annotation indicates that the target class represents a Module field.

Classes with this annotation must have a field with the BoundFieldValue annotation.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Class<? extends IBoundModule>
    moduleClass
    Get the metaschema class that "owns" this assembly, which is the concrete implementation of the metaschema containing the assembly.
    String
    name
    Name of the field.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    Get the documentary description of the field.
    String
    formalName
    Get the documentary formal name of the field.
    int
    index
    The binary name of the assembly.
    boolean
    inXmlWrapped
    If the data type allows it, determines if the field's value must be wrapped with an XML element whose name is the specified name() and namespace is derived from the namespace of the 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
    Get the name to use for data instances of this field.
    ValueConstraints
    valueConstraints
    Get the value constraints defined for this Metaschema field definition.

  • Element Details

    • name

      @NonNull String name
      Name of the field.
      Returns:
      the name

    • moduleClass

      @NonNull Class<? extends IBoundModule> moduleClass
      Get the metaschema class that "owns" this assembly, which is the concrete implementation of the metaschema containing the assembly.
      Returns:
      the class that extends IBoundModule

    • formalName

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

      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 field.

      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"

    • index

      int index
      The binary name of the assembly.

      The value Integer.MIN_VALUE indicates that there is no index.

      Returns:
      the index value
      Default:
      -2147483648

    • useName

      @NonNull String useName
      Get the name to use for data instances of this field.

      This overrides the name provided by name().

      The value ModelUtil.NO_STRING_VALUE indicates that there is no use name.

      Returns:
      the use name or ModelUtil.NO_STRING_VALUE 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 index.

      Returns:
      the index value or Integer.MIN_VALUE if there is no index value
      Default:
      -2147483648

    • inXmlWrapped

      boolean inXmlWrapped
      If the data type allows it, determines if the field's value must be wrapped with an XML element whose name is the specified name() and namespace is derived from the namespace of the instance.
      Returns:
      true if the field must be wrapped, or false otherwise
      Default:
      true

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

    • valueConstraints

      ValueConstraints valueConstraints
      Get the value constraints defined for this Metaschema field definition.
      Returns:
      the value constraints
      Default:
      @gov.nist.secauto.metaschema.databind.model.annotations.ValueConstraints