Package org.instancio.internal.generator.checksum

Class Mod10Generator

java.lang.Object

org.instancio.internal.generator.AbstractGenerator<String>

org.instancio.internal.generator.checksum.BaseModCheckGenerator

org.instancio.internal.generator.checksum.Mod10Generator

All Implemented Interfaces:

Generator<String>, GeneratorSpec<String>, AsGeneratorSpec<String>, Mod10AsGeneratorSpec, Mod10GeneratorSpec, Mod10Spec, NullableGeneratorSpec<String>, ValueSpec<String>, InternalLengthGeneratorSpec<String>

public class Mod10Generator
extends BaseModCheckGenerator
implements Mod10AsGeneratorSpec, Mod10Spec

Constructor Summary

Constructors

Constructor	Description
Mod10Generator()
Mod10Generator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
Mod10Generator	checkDigitIndex(int idx)	The index of the check digit in the input.
protected int	checkPosition()
Mod10Generator	endIndex(int idx)	The end index for calculating the checksum.
protected int	even(int position)
Mod10Generator	length(int length)	Length of the number to generate (default value is 16).
org.instancio.internal.generator.checksum.VariableLengthModCheckGenerator	length(int min, int max)
Mod10Generator	multiplier(int multiplier)	Multiplier to be used for odd digits when calculating the Mod10 checksum (default value is 3).
Mod10Generator	nullable()	Indicates that null value can be generated.
Mod10Generator	nullable(boolean isNullable)
protected int	odd(int position)
protected int	payloadLength()
protected int	prefixLength()
Mod10Generator	startIndex(int idx)	The start index for calculating the checksum (default value is 0).
protected int	suffixLength()
protected boolean	sumDigits()
protected String	tryGenerateNonNull(Random random)	Makes the best effort to return a non-null value.
Mod10Generator	weight(int weight)	The weight to be used for even digits when calculating the Mod10 checksum (default value is 1).

Methods inherited from class org.instancio.internal.generator.checksum.BaseModCheckGenerator

base, direction, payload, 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.specs.AsGeneratorSpec

as, asString

Methods inherited from interface org.instancio.generator.Generator

init

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Constructor Details

Mod10Generator

public Mod10Generator()

Mod10Generator

public Mod10Generator(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

length

public Mod10Generator length(int length)

Description copied from interface: Mod10GeneratorSpec

Length of the number to generate (default value is 16).

Specified by:

length in interface Mod10AsGeneratorSpec

Specified by:

length in interface Mod10GeneratorSpec

Specified by:

length in interface Mod10Spec

Parameters:

length - of the number to generate

Returns:

spec builder

multiplier

public Mod10Generator multiplier(int multiplier)

Description copied from interface: Mod10GeneratorSpec

Multiplier to be used for odd digits when calculating the Mod10 checksum (default value is 3).

Specified by:

multiplier in interface Mod10AsGeneratorSpec

Specified by:

multiplier in interface Mod10GeneratorSpec

Specified by:

multiplier in interface Mod10Spec

Parameters:

multiplier - for odd digits

Returns:

spec builder

weight

public Mod10Generator weight(int weight)

Description copied from interface: Mod10GeneratorSpec

The weight to be used for even digits when calculating the Mod10 checksum (default value is 1).

Specified by:

weight in interface Mod10AsGeneratorSpec

Specified by:

weight in interface Mod10GeneratorSpec

Specified by:

weight in interface Mod10Spec

Parameters:

weight - for even digits

Returns:

spec builder

startIndex

public Mod10Generator startIndex(int idx)

Description copied from interface: Mod10GeneratorSpec

The start index for calculating the checksum (default value is 0).

Specified by:

startIndex in interface Mod10AsGeneratorSpec

Specified by:

startIndex in interface Mod10GeneratorSpec

Specified by:

startIndex in interface Mod10Spec

Parameters:

idx - for calculating the checksum (inclusive)

Returns:

spec builder

endIndex

public Mod10Generator endIndex(int idx)

Description copied from interface: Mod10GeneratorSpec

The end index for calculating the checksum.

Specified by:

endIndex in interface Mod10AsGeneratorSpec

Specified by:

endIndex in interface Mod10GeneratorSpec

Specified by:

endIndex in interface Mod10Spec

Parameters:

idx - for calculating the checksum (inclusive)

Returns:

spec builder

checkDigitIndex

public Mod10Generator checkDigitIndex(int idx)

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 interface Mod10AsGeneratorSpec

Specified by:

checkDigitIndex in interface Mod10GeneratorSpec

Specified by:

checkDigitIndex in interface Mod10Spec

Parameters:

idx - index of the check digit

Returns:

spec builder

nullable

public Mod10Generator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface Mod10AsGeneratorSpec

Specified by:

nullable in interface Mod10GeneratorSpec

Specified by:

nullable in interface Mod10Spec

Specified by:

nullable in interface NullableGeneratorSpec<String>

Specified by:

nullable in interface ValueSpec<String>

Overrides:

nullable in class AbstractGenerator<String>

Returns:

spec builder

nullable

public Mod10Generator nullable(boolean isNullable)

Overrides:

nullable in class AbstractGenerator<String>

even

protected int even(int position)

Overrides:

even in class BaseModCheckGenerator

odd

protected int odd(int position)

Overrides:

odd in class BaseModCheckGenerator

sumDigits

protected boolean sumDigits()

Overrides:

sumDigits in class BaseModCheckGenerator

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