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

Annotation Type MetaschemaModule

@Retention(RUNTIME) @Target(TYPE) public @interface MetaschemaModule
Marks a class as a Metaschema module definition.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<? extends IBoundObject>[]
    assemblies
    Get the classes representing the global assemblies defined on this Module.
    Class<? extends IBoundObject>[]
    fields
    Get the classes representing the global fields defined on this Module.
    Class<? extends IBoundModule>[]
    imports
    Get the classes representing the Metaschemas imported by this Module.
    NsBinding[]
    nsBindings
    Get the namespace prefix bindings for this module.
    String
    remarks
    Get any remarks for this metaschema.

  • Element Details

    • fields

      @NonNull Class<? extends IBoundObject>[] fields
      Get the classes representing the global fields defined on this Module.
      Returns:
      an array of field classes
      Default:
      {}

    • assemblies

      @NonNull Class<? extends IBoundObject>[] assemblies
      Get the classes representing the global assemblies defined on this Module.
      Returns:
      an array of assembly classes
      Default:
      {}

    • imports

      @NonNull Class<? extends IBoundModule>[] imports
      Get the classes representing the Metaschemas imported by this Module.
      Returns:
      an array of imported Metaschemas
      Default:
      {}

    • nsBindings

      @NonNull NsBinding[] nsBindings
      Get the namespace prefix bindings for this module.
      Returns:
      an array of namespace bindings
      Default:
      {}

    • remarks

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