Module dev.metaschema.databind
Package dev.metaschema.databind.model.annotations

Annotation Type Report

@Documented @Retention(RUNTIME) @Target(ANNOTATION_TYPE) public @interface Report
This annotation defines a report condition in the context of the containing annotation.

Report constraints generate findings when their test expression evaluates to true, which is the opposite of expect constraints.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    test
    A metapath that is expected to evaluate to true when a finding should be reported.

  • 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.
    Property[]
    properties
    An optional set of properties associated with this constraint.
    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.

  • Element Details

    • test

      @NonNull String test
      A metapath that is expected to evaluate to true when a finding should be reported.

      This is the opposite of expect constraints - report constraints fire when the test is true.

      Returns:
      a metapath expression

    • 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.

      The default level for report constraints is IConstraint.Level.INFORMATIONAL, which differs from expect constraints that default to IConstraint.Level.ERROR.

      Returns:
      the level
      Default:
      INFORMATIONAL

    • 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 BoundFieldValue 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 this constraint.
      Returns:
      the properties or an empty array with no properties
      Default:
      {}

    • 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:
      ""