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

Annotation Type ValueConstraints

@Documented @Retention(RUNTIME) @Target(ANNOTATION_TYPE) public @interface ValueConstraints
Defines value-level constraints for field and flag definitions.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    AllowedValues[]
    allowedValues
    Get the allowed value constraints for the type or field this annotation is applied to.
    Expect[]
    expect
    Get the expect constraints for the type or field this annotation is applied to.
    IndexHasKey[]
    indexHasKey
    Get the index-has-key constraints for the type or field this annotation is applied to.
    Let[]
    lets
    Get the let statements for the type of field this annotation is applied to.
    Matches[]
    matches
    Get the matches constraints for the type or field this annotation is applied to.
    Report[]
    report
    Get the report constraints for the type or field this annotation is applied to.

  • Element Details

    • lets

      @NonNull Let[] lets
      Get the let statements for the type of field this annotation is applied to.
      Returns:
      the let statements or an empty array if no let statements are defined
      Default:
      {}

    • allowedValues

      @NonNull AllowedValues[] allowedValues
      Get the allowed value constraints for the type or field this annotation is applied to.
      Returns:
      the allowed values or an empty array if no allowed values constraints are defined
      Default:
      {}

    • matches

      @NonNull Matches[] matches
      Get the matches constraints for the type or field this annotation is applied to.
      Returns:
      the allowed values or an empty array if no allowed values constraints are defined
      Default:
      {}

    • indexHasKey

      @NonNull IndexHasKey[] indexHasKey
      Get the index-has-key constraints for the type or field this annotation is applied to.
      Returns:
      the allowed values or an empty array if no allowed values constraints are defined
      Default:
      {}

    • expect

      @NonNull Expect[] expect
      Get the expect constraints for the type or field this annotation is applied to.
      Returns:
      the expected constraints or an empty array if no expected constraints are defined
      Default:
      {}

    • report

      @NonNull Report[] report
      Get the report constraints for the type or field this annotation is applied to.

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

      Returns:
      the report constraints or an empty array if no report constraints are defined
      Default:
      {}