Package org.instancio.internal.generator.domain.internet

Class EmailGenerator

java.lang.Object

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

org.instancio.internal.generator.domain.internet.EmailGenerator

All Implemented Interfaces:

Generator<String>, GeneratorSpec<String>, AsGeneratorSpec<String>, EmailAsGeneratorSpec, EmailGeneratorSpec, EmailSpec, NullableGeneratorSpec<String>, ValueSpec<String>, InternalLengthGeneratorSpec<String>

public class EmailGenerator
extends AbstractGenerator<String>
implements EmailSpec, EmailAsGeneratorSpec, 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
EmailGenerator()
EmailGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
EmailGenerator	length(int length)	Specifies email address length.
EmailGenerator	length(int min, int max)	Specifies email address length range.
EmailGenerator	nullable()	Indicates that null value can be generated.
EmailGenerator	nullable(boolean isNullable)
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

Methods inherited from interface org.instancio.generator.specs.AsGeneratorSpec

as, asString

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Constructor Details

EmailGenerator

public EmailGenerator()

EmailGenerator

public EmailGenerator(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 EmailGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface EmailAsGeneratorSpec

Specified by:

nullable in interface EmailGeneratorSpec

Specified by:

nullable in interface EmailSpec

Specified by:

nullable in interface NullableGeneratorSpec<String>

Specified by:

nullable in interface ValueSpec<String>

Overrides:

nullable in class AbstractGenerator<String>

Returns:

spec builder

nullable

public EmailGenerator nullable(boolean isNullable)

Overrides:

nullable in class AbstractGenerator<String>

length

public EmailGenerator length(int min,
 int max)

Description copied from interface: EmailGeneratorSpec

Specifies email address length range.

Specified by:

length in interface EmailAsGeneratorSpec

Specified by:

length in interface EmailGeneratorSpec

Specified by:

length in interface EmailSpec

Specified by:

length in interface InternalLengthGeneratorSpec<String>

Parameters:

min - minimum length of address (inclusive)

max - maximum length of address (inclusive)

Returns:

spec builder

length

public EmailGenerator length(int length)

Description copied from interface: EmailGeneratorSpec

Specifies email address length.

Specified by:

length in interface EmailAsGeneratorSpec

Specified by:

length in interface EmailGeneratorSpec

Specified by:

length in interface EmailSpec

Parameters:

length - of email address

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