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 IModule>	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 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.
String	remarks	Get any remarks for this assembly.
String	rootName	Name of the root XML element or the JSON/YAML property.
String	rootNamespace	XML target namespace of the XML element.

Element Detail

moduleClass

Class<? extends IModule> moduleClass

Get the metaschema class that "owns" this assembly, which is the concrete implementation of the metaschema containing the assembly.

Returns:

the IModule 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"

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"

rootNamespace

@NonNull
String rootNamespace

XML target namespace of the XML element.

If the value is "##default", then namespace is derived from the namespace provided in the package-info.

Returns:

the namespace

Default:

"##default"

remarks

@NonNull
String remarks

Get any remarks for this assembly.

Returns:

a markdown string or "##none" if no remarks are provided

Default:

"##none"