Module gov.nist.secauto.metaschema.databind

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

Annotation Type BoundAssembly

@Documented
@Retention(RUNTIME)
@Target(FIELD)
public @interface BoundAssembly

Identifies that the annotation target is a bound property that references a Module assembly.

For XML serialization, the useName() identifies the name of the element to use and the namespace() identifies the namespace of this element.

For JSON and YAML serializations, the useName() identifies the property/item name to use.

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	maxOccurs	A number that indicates the maximum occurrence of the model instance.
int	minOccurs	A non-negative number that indicates the minimum occurrence of the model instance.
String	namespace	The namespace to use for associated XML elements.
String	remarks	Get any remarks for this field.
String	useName	The model name to use for singleton values.

Element Detail

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"

useName

@NonNull
String useName

The model name to use for singleton values. This name will be used for associated XML elements.

If the value is "##none", then element name is derived from the JavaBean property name.

Returns:

the name or "##none" if no use name is provided

Default:

"##none"

namespace

@NonNull
String namespace

The namespace to use for associated XML elements.

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

Returns:

the namespace

Default:

"##default"

minOccurs

int minOccurs

A non-negative number that indicates the minimum occurrence of the model instance.

Returns:

a non-negative number

Default:

0

maxOccurs

int maxOccurs

A number that indicates the maximum occurrence of the model instance.

Returns:

a positive number or -1 to indicate "unbounded"

Default:

1

remarks

@NonNull
String remarks

Get any remarks for this field.

Returns:

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

Default:

"##none"