Package org.instancio.internal.generator.checksum

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>

public class LuhnGenerator
extends BaseModCheckGenerator

Constructor Summary

Constructors

Constructor	Description
LuhnGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
org.instancio.internal.generator.checksum.VariableLengthModCheckGenerator	checkDigitIndex(int idx)
protected int	checkPosition()
LuhnGenerator	endIndex(int idx)
org.instancio.internal.generator.checksum.VariableLengthModCheckGenerator	length(int length)
org.instancio.internal.generator.checksum.VariableLengthModCheckGenerator	length(int min, int max)
LuhnGenerator	nullable()	Indicates that null value can be generated.
LuhnGenerator	nullable(boolean isNullable)
protected int	payloadLength()
protected int	prefixLength()
LuhnGenerator	startIndex(int idx)
protected int	suffixLength()
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.instancio.generator.Generator

init

Constructor Details

LuhnGenerator

public LuhnGenerator(GeneratorContext context)

Method Details

apiMethod

public String 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 class AbstractGenerator<String>

Returns:

spec name if defined, or null otherwise

nullable

public LuhnGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<String>

Overrides:

nullable in class AbstractGenerator<String>

Returns:

spec builder

nullable

public LuhnGenerator nullable(boolean isNullable)

Overrides:

nullable in class AbstractGenerator<String>

startIndex

public LuhnGenerator startIndex(int idx)

endIndex

public LuhnGenerator endIndex(int idx)

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 interface InternalLengthGeneratorSpec<String>

tryGenerateNonNull

protected String tryGenerateNonNull(Random random)

Description copied from class: AbstractGenerator

Makes the best effort to return a non-null value. However, in certain cases this method will produce a null.

Overrides:

tryGenerateNonNull in class BaseModCheckGenerator

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null

prefixLength

protected int prefixLength()

Overrides:

prefixLength in class BaseModCheckGenerator

payloadLength

protected int payloadLength()

Specified by:

payloadLength in class BaseModCheckGenerator

checkPosition

protected int checkPosition()

Overrides:

checkPosition in class BaseModCheckGenerator

suffixLength

protected int suffixLength()

Overrides:

suffixLength in class BaseModCheckGenerator