Package org.instancio.internal.generator.lang

Class CharacterGenerator

java.lang.Object

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

org.instancio.internal.generator.lang.CharacterGenerator

All Implemented Interfaces:

AsStringGeneratorSpec<Character>, Generator<Character>, GeneratorSpec<Character>, CharacterAsStringGeneratorSpec, CharacterGeneratorSpec, CharacterSpec, NullableGeneratorSpec<Character>, ValueSpec<Character>

public class CharacterGenerator
extends AbstractGenerator<Character>
implements CharacterSpec, CharacterAsStringGeneratorSpec

Constructor Summary

Constructors

Constructor	Description
CharacterGenerator()
CharacterGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
Character	generate(Random random)	Returns a generated value.
CharacterGenerator	nullable()	Indicates that null value can be generated.
CharacterGenerator	range(char min, char max)	Range of characters to generate.

Methods inherited from class org.instancio.internal.generator.AbstractGenerator

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

asString, asString

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Constructor Details

CharacterGenerator

public CharacterGenerator(GeneratorContext context)

CharacterGenerator

public CharacterGenerator()

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<Character>

Returns:

spec name if defined, or null otherwise

range

public CharacterGenerator range(char min,
 char max)

Description copied from interface: CharacterGeneratorSpec

Range of characters to generate.

Specified by:

range in interface CharacterAsStringGeneratorSpec

Specified by:

range in interface CharacterGeneratorSpec

Specified by:

range in interface CharacterSpec

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

nullable

public CharacterGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface CharacterAsStringGeneratorSpec

Specified by:

nullable in interface CharacterGeneratorSpec

Specified by:

nullable in interface CharacterSpec

Specified by:

nullable in interface NullableGeneratorSpec<Character>

Overrides:

nullable in class AbstractGenerator<Character>

Returns:

spec builder

generate

public Character generate(Random random)

Description copied from interface: Generator

Returns a generated value.

If this method produces random data, the data needs to be generated using the provided Random instance. This ensures generated values are reproducible for a given seed value.

Specified by:

generate in interface Generator<Character>

Parameters:

random - provider for generating random values

Returns:

generated value or null if value is nullable, could not be generated, or generation is delegated to the engine