Package org.instancio.internal.generator.text

Class EmailAddressGenerator

java.lang.Object

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

org.instancio.internal.generator.text.EmailAddressGenerator

All Implemented Interfaces:

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

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

Internal generator used for generating email addresses for fields annotated with @Email annotation from Jakarta Bean Validation API.

Constructor Summary

Constructors

Constructor	Description
EmailAddressGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
String	generate(Random random)	Returns a generated value.
EmailAddressGenerator	length(int length)
EmailAddressGenerator	length(int min, int max)
EmailAddressGenerator	nullable()	Indicates that null value can be generated.
EmailAddressGenerator	nullable(boolean isNullable)

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

getContext, hints, isNullable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EmailAddressGenerator

public EmailAddressGenerator(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 EmailAddressGenerator 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 EmailAddressGenerator nullable(boolean isNullable)

Overrides:

nullable in class AbstractGenerator<String>

length

public EmailAddressGenerator length(int min,
 int max)

Specified by:

length in interface InternalLengthGeneratorSpec<String>

length

public EmailAddressGenerator length(int length)

generate

public String 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<String>

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