Package de.knightsoftnet.validators.shared

Annotation Type PostalCode

@Documented @Constraint(validatedBy=PostalCodeValidator.class) @Target({TYPE,ANNOTATION_TYPE}) @Retention(RUNTIME) public @interface PostalCode
The annotated bean must contain two properties:
  • country code (option fieldCountryCode)
  • postal code/zip (option fieldPostalCode)
The postal code is checked against country specific rules for validity.
Supported types are beans, null elements are considered valid.
If allowLowerCaseCountryCode is set to true, lower case country codes are accepted.
Author:
Manfred Tremmel

  • Nested Class Summary

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

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    allowLowerCaseCountryCode
    are lower case country codes allowed (true/false).
    String
    fieldCountryCode
    field name of the country code field.
    String
    fieldPostalCode
    field name of the postal code (zip) field.
    Class<?>[]
    groups
    groups to use.
    String
    message
    localized message.
    Class<? extends jakarta.validation.Payload>[]
    payload
    payload whatever.

  • Element Details

    • message

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

    • groups

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

    • payload

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

    • fieldCountryCode

      String fieldCountryCode
      field name of the country code field.
      Returns:
      field/path contains country code
      Default:
      "countryCode"

    • allowLowerCaseCountryCode

      boolean allowLowerCaseCountryCode
      are lower case country codes allowed (true/false).
      Returns:
      true if lower case country code is allowed
      Default:
      false

    • fieldPostalCode

      String fieldPostalCode
      field name of the postal code (zip) field.
      Returns:
      field/path contains vat postal code
      Default:
      "postalCode"