Package org.instancio.internal.generator.text

Class TextPatternGenerator

java.lang.Object

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

org.instancio.internal.generator.text.TextPatternGenerator

All Implemented Interfaces:

Generator<String>, GeneratorSpec<String>, NullableGeneratorSpec<String>, ValueSpec<String>

public class TextPatternGenerator
extends AbstractGenerator<String>
implements ValueSpec<String>

Constructor Summary

Constructors

Constructor	Description
TextPatternGenerator(String pattern)
TextPatternGenerator(GeneratorContext context, String pattern)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
TextPatternGenerator	nullable()	Indicates that null value can be generated.
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, nullable

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.ValueSpec

get, list, map, stream, toModel

Constructor Details

TextPatternGenerator

public TextPatternGenerator(String pattern)

TextPatternGenerator

public TextPatternGenerator(GeneratorContext context,
 String pattern)

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 TextPatternGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<String>

Specified by:

nullable in interface ValueSpec<String>

Overrides:

nullable in class AbstractGenerator<String>

Returns:

spec builder

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