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>, AsGeneratorSpec<Character>, CharacterAsGeneratorSpec, CharacterGeneratorSpec, CharacterSpec, NullableGeneratorSpec<Character>, ValueSpec<Character>

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

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.
CharacterGenerator	nullable()	Indicates that null value can be generated.
CharacterGenerator	range(char min, char max)	Range of characters to generate.
protected Character	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.specs.AsGeneratorSpec

as, asString

Methods inherited from interface org.instancio.generator.AsStringGeneratorSpec

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 CharacterAsGeneratorSpec

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 CharacterAsGeneratorSpec

Specified by:

nullable in interface CharacterGeneratorSpec

Specified by:

nullable in interface CharacterSpec

Specified by:

nullable in interface NullableGeneratorSpec<Character>

Specified by:

nullable in interface ValueSpec<Character>

Overrides:

nullable in class AbstractGenerator<Character>

Returns:

spec builder

tryGenerateNonNull

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

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null