Package de.knightsoftnet.validators.shared

Annotation Type MustBeEqualIfOtherHasValue

@Documented @Constraint(validatedBy=MustBeEqualIfOtherHasValueValidator.class) @Target({TYPE,ANNOTATION_TYPE}) @Retention(RUNTIME) public @interface MustBeEqualIfOtherHasValue
The annotated bean must contain at least four properties:
  • a field to compare (option field1)
  • another field to compared (option field2)
  • a field which entry is compared against a value (option fieldCompare and valueCompare)
  • add the error to field1 (option addErrorToField1, default true)
  • add the error to field2 (option addErrorToField2, default true)
the entry of field1 must be equal to the entry of field2 when the entry of fieldCompare has the value valueCompare, can be used e.g. for password and password repeat fields.
Supported types are beans, null elements are considered valid.
Author:
Manfred Tremmel

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    MustBeEqualIfOtherHasValue.List
    Defines several MustBeEqualIfOtherHasValue annotations on the same element.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    field1
    field1 name to compare.
    String
    field2
    field2 name to compare.
    String
    fieldCompare
    field name to compare.
    String[]
    valueCompare
    value the compare field must have to check.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    addErrorToField1
    add error to field1 (default true).
    boolean
    addErrorToField2
    add error to field2 (default true).
    Class<?>[]
    groups
    groups to use.
    String
    message
    localized message.
    Class<? extends jakarta.validation.Payload>[]
    payload
    payload whatever.

  • Element Details

    • field1

      String field1
      field1 name to compare.
      Returns:
      field/path contains value to compare

    • field2

      String field2
      field2 name to compare.
      Returns:
      field/path contains value to compare

    • fieldCompare

      String fieldCompare
      field name to compare.
      Returns:
      field/path contains value to compare

    • valueCompare

      String[] valueCompare
      value the compare field must have to check.
      Returns:
      value to compare

    • message

      String message
      localized message.
      Returns:
      localized validation message
      Default:
      "{de.knightsoftnet.validators.shared.MustBeEqual.message}"

    • groups

      Class<?>[] groups
      groups to use.
      Returns:
      array of validation groups
      Default:
      {}

    • addErrorToField1

      boolean addErrorToField1
      add error to field1 (default true).
      Returns:
      true if error should be added to field1
      Default:
      true

    • addErrorToField2

      boolean addErrorToField2
      add error to field2 (default true).
      Returns:
      true if error should be added to field2
      Default:
      true

    • payload

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