Package org.instancio.internal.generator.text

Class LuhnGenerator

java.lang.Object

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

org.instancio.internal.generator.text.LuhnGenerator

All Implemented Interfaces:

Generator<String>, GeneratorSpec<String>, NullableGeneratorSpec<String>, InternalLengthGeneratorSpec<String>

public class LuhnGenerator
extends AbstractGenerator<String>
implements NullableGeneratorSpec<String>, InternalLengthGeneratorSpec<String>

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.
LuhnGenerator	checkIndex(int idx)
LuhnGenerator	endIndex(int idx)
LuhnGenerator	length(int length)
LuhnGenerator	length(int min, int max)
LuhnGenerator	nullable()	Indicates that null value can be generated.
LuhnGenerator	nullable(boolean isNullable)
LuhnGenerator	startIndex(int idx)
protected String	tryGenerateNonNull(Random random)	Makes the best effort to return a non-null value.

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

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)

checkIndex

public LuhnGenerator checkIndex(int idx)

length

public LuhnGenerator length(int length)

length

public LuhnGenerator 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.

Specified by:

tryGenerateNonNull in class AbstractGenerator<String>

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null