Annotation Interface InList

@Documented @Constraint(validatedBy=InListValidator.class) @Target({FIELD,METHOD,PARAMETER,TYPE_USE}) @Retention(RUNTIME) public @interface InList
Constraint that validates that a String value is in the specified list.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String[]
    value
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    caseSensitive
     
    Class<?>[]
    groups
     
    String
    message
     
    Class<? extends jakarta.validation.Payload>[]
    payload
     

  • Element Details

    • value

      String[] value
      Returns:
      The list of values to check against.

    • caseSensitive

      boolean caseSensitive
      Returns:
      Whether the comparison is case-sensitive.
      Default:
      true

    • message

      String message
      Returns:
      message code
      Default:
      "Not in the list of supported values ({validatedValue})"

    • groups

      Class<?>[] groups
      Returns:
      The groups to apply
      Default:
      {}

    • payload

      Class<? extends jakarta.validation.Payload>[] payload
      Returns:
      The payload
      Default:
      {}