Package org.instancio.generator.specs
Interface Mod10AsGeneratorSpec
- All Superinterfaces:
AsGeneratorSpec<String>
,GeneratorSpec<String>
,Mod10GeneratorSpec
,NullableGeneratorSpec<String>
- All Known Implementing Classes:
Mod10Generator
A spec for generating numbers that pass the Mod10 checksum algorithm.
This spec supports
AsGeneratorSpec
.- Since:
- 2.16.0
-
Method Summary
Modifier and TypeMethodDescriptioncheckDigitIndex
(int checkDigitIndex) The index of the check digit in the input.endIndex
(int endIndex) The end index for calculating the checksum.length
(int length) Length of the number to generate (default value is16
).multiplier
(int multiplier) Multiplier to be used for odd digits when calculating the Mod10 checksum (default value is3
).nullable()
Indicates thatnull
value can be generated.startIndex
(int startIndex) The start index for calculating the checksum (default value is0
).weight
(int weight) The weight to be used for even digits when calculating the Mod10 checksum (default value is1
).Methods inherited from interface org.instancio.generator.specs.AsGeneratorSpec
as, asString
-
Method Details
-
length
Description copied from interface:Mod10GeneratorSpec
Length of the number to generate (default value is16
).- Specified by:
length
in interfaceMod10GeneratorSpec
- Parameters:
length
- of the number to generate- Returns:
- spec builder
-
multiplier
Description copied from interface:Mod10GeneratorSpec
Multiplier to be used for odd digits when calculating the Mod10 checksum (default value is3
).- Specified by:
multiplier
in interfaceMod10GeneratorSpec
- Parameters:
multiplier
- for odd digits- Returns:
- spec builder
-
weight
Description copied from interface:Mod10GeneratorSpec
The weight to be used for even digits when calculating the Mod10 checksum (default value is1
).- Specified by:
weight
in interfaceMod10GeneratorSpec
- Parameters:
weight
- for even digits- Returns:
- spec builder
-
startIndex
Description copied from interface:Mod10GeneratorSpec
The start index for calculating the checksum (default value is0
).- Specified by:
startIndex
in interfaceMod10GeneratorSpec
- Parameters:
startIndex
- for calculating the checksum (inclusive)- Returns:
- spec builder
-
endIndex
Description copied from interface:Mod10GeneratorSpec
The end index for calculating the checksum.- Specified by:
endIndex
in interfaceMod10GeneratorSpec
- Parameters:
endIndex
- for calculating the checksum (inclusive)- Returns:
- spec builder
-
checkDigitIndex
Description copied from interface:Mod10GeneratorSpec
The index of the check digit in the input. If not specified, the last digit will be used as the check digit.If set, the digit at the specified index is used. If set the following must hold true:
checkDigitIndex >= 0 && (checkDigitIndex < startIndex || checkDigitIndex >= endIndex)
.- Specified by:
checkDigitIndex
in interfaceMod10GeneratorSpec
- Parameters:
checkDigitIndex
- index of the check digit- Returns:
- spec builder
-
nullable
Mod10AsGeneratorSpec nullable()Description copied from interface:Mod10GeneratorSpec
Indicates thatnull
value can be generated.- Specified by:
nullable
in interfaceMod10GeneratorSpec
- Specified by:
nullable
in interfaceNullableGeneratorSpec<String>
- Returns:
- spec builder
-