Module gov.nist.secauto.metaschema.databind

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

Annotation Type Matches

@Documented
@Retention(RUNTIME)
@Target(ANNOTATION_TYPE)
public @interface Matches

This annotation defines a rule that requires matching patterns and/or data types among the target contents of the assembly represented by the containing MetaschemaAssembly annotation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	description	An optional description of the constraint.
String	formalName	An optional formal name for the constraint.
String	id	An optional identifier for the constraint, which must be unique to only this constraint.
IConstraint.Level	level	The significance of a violation of this constraint.
String	message	The message to emit when the constraint is violated.
String	pattern	Retrieve an optional pattern that the associated value must match.
Property[]	properties	An optional set of properties associated with these allowed values.
String	remarks	Any remarks about the constraint, encoded as an escaped Markdown string.
String	target	An optional metapath that points to the target flag or field value that the constraint applies to.
Class<? extends IDataTypeAdapter<?>>	typeAdapter	The Module data type adapter for the data type that the associated value must conform to.

Element Detail

id

@NonNull
String id

An optional identifier for the constraint, which must be unique to only this constraint.

Returns:

the identifier if provided or an empty string otherwise

Default:

""

formalName

@NonNull
String formalName

An optional formal name for the constraint.

Returns:

the formal name if provided or an empty string otherwise

Default:

""

description

@NonNull
String description

An optional description of the constraint.

Returns:

the description if provided or an empty string otherwise

Default:

""

level

@NonNull
IConstraint.Level level

The significance of a violation of this constraint.

Returns:

the level

Default:

gov.nist.secauto.metaschema.core.model.constraint.IConstraint.Level.ERROR

target

@NonNull
String target

An optional metapath that points to the target flag or field value that the constraint applies to. If omitted the target will be ".", which means the target is the value of the BoundFlag, BoundField or MetaschemaFieldValue annotation the constraint appears on. In the prior case, this annotation may only appear on a BoundField if the field has no flags, which results in a BoundField annotation on a field instance with a scalar, data type value.

Returns:

the target metapath

Default:

"."

properties

Property[] properties

An optional set of properties associated with these allowed values.

Returns:

the properties or an empty array with no properties

Default:

{}

pattern

@NonNull
String pattern

Retrieve an optional pattern that the associated value must match. This must be a pattern that can compile using Pattern.compile(String).

Returns:

a pattern string or an empty string if no pattern is provided

Default:

""

typeAdapter

@NonNull
Class<? extends IDataTypeAdapter<?>> typeAdapter

The Module data type adapter for the data type that the associated value must conform to.

Returns:

the data type adapter or a NullJavaTypeAdapter if none is provided

Default:

gov.nist.secauto.metaschema.databind.model.annotations.NullJavaTypeAdapter.class

message

@NonNull
String message

The message to emit when the constraint is violated.

Returns:

the message or an empty string otherwise

Default:

""

remarks

@NonNull
String remarks

Any remarks about the constraint, encoded as an escaped Markdown string.

Returns:

an encoded markdown string or an empty string if no remarks are provided

Default:

""