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

Annotation Type MetaschemaAssembly

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

  • Required Element Summary

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

  • 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.
    int
    index
    The binary name of the assembly.
    AssemblyConstraints
    modelConstraints
    Get the model constraints defined for this Metaschema assembly definition.
    Property[]
    properties
    An optional set of associated properties.
    String
    remarks
    Get any remarks for this assembly.
    int
    rootIndex
    The binary root name of the assembly.
    String
    rootName
    Name of the root XML element or the JSON/YAML property.
    ValueConstraints
    valueConstraints
    Get the value constraints defined for this Metaschema assembly definition.

  • Element Details

    • moduleClass

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

    • name

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

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

    • 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

    • rootName

      @NonNull String rootName
      Name of the root XML element or the JSON/YAML property.

      If the value is "##none", then there is no root name.

      Returns:
      the name
      Default:
      "##none"

    • rootIndex

      int rootIndex
      The binary root name of the assembly.

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

      Returns:
      the index value
      Default:
      -2147483648

    • 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 assembly.
      Returns:
      a markdown string or "##none" if no remarks are provided
      Default:
      "##none"

    • valueConstraints

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

    • modelConstraints

      AssemblyConstraints modelConstraints
      Get the model constraints defined for this Metaschema assembly definition.
      Returns:
      the value constraints
      Default:
      @gov.nist.secauto.metaschema.databind.model.annotations.AssemblyConstraints