org.hibernate.validator.constraints.ModCheck Maven / Gradle / Ivy
/*
* Hibernate Validator, declare and validate application constraints
*
* License: Apache License, Version 2.0
* See the license.txt file in the root directory or .
*/
package org.hibernate.validator.constraints;
import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.CONSTRUCTOR;
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.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Documented;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import jakarta.validation.Constraint;
import jakarta.validation.Payload;
/**
* Modulo check constraint.
*
* Allows to validate that a series of digits pass the mod 10 or mod 11 checksum algorithm.
*
*
* The supported type is {@code CharSequence}. {@code null} is considered valid.
*
*
* @author George Gastaldi
* @author Hardy Ferentschik
* @deprecated As of release 5.1.0, replaced by {@link Mod10Check} and {@link Mod11Check}
*/
@Documented
@Deprecated
@Constraint(validatedBy = { })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Repeatable(ModCheck.List.class)
public @interface ModCheck {
String message() default "{org.hibernate.validator.constraints.ModCheck.message}";
Class[] groups() default { };
Class[] payload() default { };
/**
* @return The modulus algorithm to be used
*/
ModType modType();
/**
* @return The multiplier to be used by the chosen mod algorithm
*/
int multiplier();
/**
* @return the start index (inclusive) for calculating the checksum. If not specified 0 is assumed.
*/
int startIndex() default 0;
/**
* @return the end index (exclusive) for calculating the checksum. If not specified the whole value is considered
*/
int endIndex() default Integer.MAX_VALUE;
/**
* @return The position of the check digit in input. Per default it is assumes that the check digit is part of the
* specified range. If set, the digit at the specified position is used as check digit. If set it the following holds
* true: {@code checkDigitPosition > 0 && (checkDigitPosition < startIndex || checkDigitPosition >= endIndex}.
*/
int checkDigitPosition() default -1;
/**
* @return Returns {@code true} if non digit characters should be ignored, {@code false} if a non digit character
* results in a validation error. {@code startIndex} and {@code endIndex} are always only referring to digit
* characters.
*/
boolean ignoreNonDigitCharacters() default true;
/**
* Defines several {@code @ModCheck} annotations on the same element.
*/
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Documented
public @interface List {
ModCheck[] value();
}
enum ModType {
/**
* Represents a MOD10 algorithm (Also known as Luhn algorithm)
*/
MOD10,
/**
* Represents a MOD11 algorithm. A remainder of 10 or 11 in the algorithm is mapped to the check digit 0.
*/
MOD11
}
}