@Modulo 10 check constraint.

Allows to validate that a series of digits pass the Mod10 checksum algorithm. The classic Mod10 is calculated by summing up the digits, with every odd digit (from right to left) value multiplied by a multiplier. As example ISBN-13 is Modulo 10 checksum with multiplier = 3.

There are known cases of codes using multipliers for both even and odd digits; To support this kind of implementations the Mod10 constraint uses the weight option, which has the same effect as the multiplier but for even numbers.

The supported type is CharSequence. null is considered valid.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static @interface	Mod10Check.List Defines several `@Mod10Check` annotations on the same element.

Method Summary

Modifier and Type	Method and Description
public int	Returns: The index of the check digit in the input. Per default it is assumed that the check digit is the last digit of the specified range. If set, the digit at the specified index is used. If set the following must hold true: `checkDigitIndex > 0 && (checkDigitIndex < startIndex \|\| checkDigitIndex >= endIndex`. checkDigitIndex()
public int	Returns: the end index (inclusive) for calculating the checksum. If not specified the whole value is considered. endIndex()
public Class<?>[]	groups()
public boolean	Returns: Whether non-digit characters in the validated input should be ignored (`true`) or result in a validation error (`false`). ignoreNonDigitCharacters()
public String	message()
public int	Returns: The multiplier to be used for odd digits when calculating the Mod10 checksum. multiplier()
public Class<? extends Payload>[]	payload()
public int	Returns: the start index (inclusive) for calculating the checksum. If not specified 0 is assumed. startIndex()
public int	Returns: The weight to be used for even digits when calculating the Mod10 checksum. weight()

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

checkDigitIndex	back to summary
public int checkDigitIndex() Returns:int The index of the check digit in the input. Per default it is assumed that the check digit is the last digit of the specified range. If set, the digit at the specified index is used. If set the following must hold true: `checkDigitIndex > 0 && (checkDigitIndex < startIndex \|\| checkDigitIndex >= endIndex`.

endIndex	back to summary
public int endIndex() Returns:int the end index (inclusive) for calculating the checksum. If not specified the whole value is considered.

groups	back to summary
public Class<?>[] groups()

ignoreNonDigitCharacters	back to summary
public boolean ignoreNonDigitCharacters() Returns:boolean Whether non-digit characters in the validated input should be ignored (`true`) or result in a validation error (`false`).

message	back to summary
public String message()

multiplier	back to summary
public int multiplier() Returns:int The multiplier to be used for odd digits when calculating the Mod10 checksum.

payload	back to summary
public Class<? extends Payload>[] payload()

startIndex	back to summary
public int startIndex() Returns:int the start index (inclusive) for calculating the checksum. If not specified 0 is assumed.

weight	back to summary
public int weight() Returns:int The weight to be used for even digits when calculating the Mod10 checksum.

org.hibernate.validator.constraints back to summary

public @Interface Mod10Check.List

Annotations

extends Annotation

@Target:METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE
@Retention:RUNTIME
@Documented

Defines several @Mod10Check annotations on the same element.

Method Summary

Modifier and Type	Method and Description
public Mod10Check[]	value()

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

value	back to summary
public Mod10Check[] value()