ModCheck (Hibernate Validator 4.3.2.Final)

```
@Documented
@Constraint(validatedBy={})
@Target(value={METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER})
@Retention(value=RUNTIME)
public @interface ModCheck
```
Modulo check constraint.
Allows to validate that a series of digits pass the mod 10 or mod 11 checksum algorithm.

The supported type is CharSequence. null is considered valid.

Author:

George Gastaldi, Hardy Ferentschik

Required Element Summary

Required Elements
Modifier and Type Required Element and Description

ModCheck.ModType modType

int multiplier

Required Elements
Modifier and Type	Required Element and Description
`ModCheck.ModType`	`modType`
`int`	`multiplier`

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`int`	`checkDigitPosition`
`int`	`endIndex`
`Class<?>[]`	`groups`
`boolean`	`ignoreNonDigitCharacters`
`String`	`message`
`Class<? extends Payload>[]`	`payload`
`int`	`startIndex`

- Element Detail
  - modType
```
public abstract ModCheck.ModType modType
```
    Returns:
    The modulus algorithm to be used
  - multiplier
```
public abstract int multiplier
```
    Returns:
    The multiplier to be used by the chosen mod algorithm
  - message
```
public abstract String message
```
    Default:
    
    "{org.hibernate.validator.constraints.ModCheck.message}"
  - groups
```
public abstract Class<?>[] groups
```
    Default:
    
    {}
  - payload
```
public abstract Class<? extends Payload>[] payload
```
    Default:
    
    {}
  - startIndex
```
public abstract int startIndex
```
    Returns:
    the start index (inclusive) for calculating the checksum. If not specified 0 is assumed.
    
    Default:
    
    0
  - endIndex
```
public abstract int endIndex
```
    Returns:
    the end index (exclusive) for calculating the checksum. If not specified the whole value is considered
    
    Default:
    
    2147483647
  - checkDigitPosition
```
public abstract int checkDigitPosition
```
    Returns:
    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: checkDigitPosition > 0 && (checkDigitPosition < startIndex || checkDigitPosition >= endIndex.
    
    Default:
    
    -1
  - ignoreNonDigitCharacters
```
public abstract boolean ignoreNonDigitCharacters
```
    Returns:
    Returns true if non digit characters should be ignored, false if a non digit character results in a validation error. startIndex and endIndex are always only referring to digit characters.
    
    Default:
    
    true

Annotation Type ModCheck

Required Element Summary

Optional Element Summary

Element Detail

modType

multiplier

message

groups

payload

startIndex

endIndex

checkDigitPosition

ignoreNonDigitCharacters