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 MetaschemaFieldValue annotation.

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 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.
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.
String	remarks	Get any remarks for this field.
String	useName

Element Detail

name

@NonNull
String name

Name of the field.

Returns:

the name

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 class that extends IModule

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"

useName

@NonNull
String useName

Default:

"##none"

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

remarks

@NonNull
String remarks

Get any remarks for this field.

Returns:

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

Default:

"##none"