Class LuhnGenerator
java.lang.Object
org.instancio.internal.generator.AbstractGenerator<String>
org.instancio.internal.generator.checksum.BaseModCheckGenerator
org.instancio.internal.generator.checksum.LuhnGenerator
- All Implemented Interfaces:
Generator<String>
,GeneratorSpec<String>
,NullableGeneratorSpec<String>
,InternalLengthGeneratorSpec<String>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the public API method name of the generator spec.org.instancio.internal.generator.checksum.VariableLengthModCheckGenerator
checkDigitIndex
(int idx) protected int
endIndex
(int idx) org.instancio.internal.generator.checksum.VariableLengthModCheckGenerator
length
(int length) org.instancio.internal.generator.checksum.VariableLengthModCheckGenerator
length
(int min, int max) nullable()
Indicates thatnull
value can be generated.nullable
(boolean isNullable) protected int
protected int
startIndex
(int idx) protected int
protected String
tryGenerateNonNull
(Random random) Makes the best effort to return a non-null value.Methods inherited from class org.instancio.internal.generator.checksum.BaseModCheckGenerator
base, direction, even, odd, payload, sumDigits, treat10As, treat11As
Methods inherited from class org.instancio.internal.generator.AbstractGenerator
generate, getContext, hints, isNullable
-
Constructor Details
-
LuhnGenerator
-
-
Method Details
-
apiMethod
Description copied from class:AbstractGenerator
Returns the public API method name of the generator spec. The returned name is used for reporting validation errors.- Specified by:
apiMethod
in classAbstractGenerator<String>
- Returns:
- spec name if defined, or
null
otherwise
-
nullable
Description copied from interface:NullableGeneratorSpec
Indicates thatnull
value can be generated.- Specified by:
nullable
in interfaceNullableGeneratorSpec<String>
- Overrides:
nullable
in classAbstractGenerator<String>
- Returns:
- spec builder
-
nullable
- Overrides:
nullable
in classAbstractGenerator<String>
-
startIndex
-
endIndex
-
checkDigitIndex
public org.instancio.internal.generator.checksum.VariableLengthModCheckGenerator checkDigitIndex(int idx) -
length
public org.instancio.internal.generator.checksum.VariableLengthModCheckGenerator length(int length) -
length
public org.instancio.internal.generator.checksum.VariableLengthModCheckGenerator length(int min, int max) - Specified by:
length
in interfaceInternalLengthGeneratorSpec<String>
-
tryGenerateNonNull
Description copied from class:AbstractGenerator
Makes the best effort to return a non-null value. However, in certain cases this method will produce anull
.- Overrides:
tryGenerateNonNull
in classBaseModCheckGenerator
- Parameters:
random
- for generating the value- Returns:
- generated value, either a null or non-null
-
prefixLength
protected int prefixLength()- Overrides:
prefixLength
in classBaseModCheckGenerator
-
payloadLength
protected int payloadLength()- Specified by:
payloadLength
in classBaseModCheckGenerator
-
checkPosition
protected int checkPosition()- Overrides:
checkPosition
in classBaseModCheckGenerator
-
suffixLength
protected int suffixLength()- Overrides:
suffixLength
in classBaseModCheckGenerator
-