Module gov.nist.secauto.metaschema.databind

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

Annotation Type GroupAs

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

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	name	The name to use for an XML grouping element wrapper or a JSON/YAML grouping property.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
JsonGroupAsBehavior	inJson	Describes how to handle collections in JSON/YAML.
XmlGroupAsBehavior	inXml	Describes how to handle collections in XML.
String	namespace	XML target namespace of the XML grouping element.

Element Detail

name

@NonNull
String name

The name to use for an XML grouping element wrapper or a JSON/YAML grouping property.

Returns:

the name

namespace

@NonNull
String namespace

XML target namespace of the XML grouping element.

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

Returns:

the namespace

Default:

"##default"

inJson

@NonNull
JsonGroupAsBehavior inJson

Describes how to handle collections in JSON/YAML.

Returns:

the JSON collection strategy

Default:

gov.nist.secauto.metaschema.core.model.JsonGroupAsBehavior.SINGLETON_OR_LIST

inXml

@NonNull
XmlGroupAsBehavior inXml

Describes how to handle collections in XML.

Returns:

the XML collection strategy

Default:

gov.nist.secauto.metaschema.core.model.XmlGroupAsBehavior.UNGROUPED