de.thksystems.validation.beanvalidation.Country Maven / Gradle / Ivy

Go to download
/*
 * tksCommons / mugwort
 *
 * Author : Thomas Kuhlmann (ThK-Systems, http://www.thk-systems.de) License : LGPL (https://www.gnu.org/licenses/lgpl.html)
 */
package de.thksystems.validation.beanvalidation;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.util.Collection;

import javax.validation.Constraint;
import javax.validation.Payload;

/**
 * The annotated {@link String} (or an arbitrary scalar object as its {@link String} representation) must be a valid country code (ISO 3166-1 ALPHA-2 code). If
 * the annotated value is a {@link Collection} or an array, every element (in its {@link String} representation) must be a valid country code.
 */
@Documented
@Constraint(validatedBy = CountryValidator.class)
@Target({METHOD, FIELD, PARAMETER})
@Retention(RUNTIME)
public @interface Country {
    String message() default "Invalid country code.";

    Class[] groups() default {};

    Class[] payload() default {};

    /**
     * Comma-separated list of additional country codes, that should be assumed as valid.
     */
    String additionalValidCountryCodes() default "";
}