Package org.instancio.internal.generator.text

Class LoremIpsumGenerator

java.lang.Object

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

org.instancio.internal.generator.text.LoremIpsumGenerator

All Implemented Interfaces:

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

public class LoremIpsumGenerator
extends AbstractGenerator<String>
implements LoremIpsumSpec

Field Summary

Fields inherited from interface org.instancio.generator.specs.LoremIpsumGeneratorSpec

DEFAULT_PARAGRAPHS, DEFAULT_WORDS

Constructor Summary

Constructors

Constructor	Description
LoremIpsumGenerator()
LoremIpsumGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
LoremIpsumGenerator	nullable()	Indicates that null value can be generated.
LoremIpsumGenerator	paragraphs(int paragraphs)	Number of paragraphs to generate.
protected String	tryGenerateNonNull(Random random)	Makes the best effort to return a non-null value.
LoremIpsumGenerator	words(int words)	Number of words to generate.

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

LoremIpsumGenerator

public LoremIpsumGenerator()

LoremIpsumGenerator

public LoremIpsumGenerator(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

words

public LoremIpsumGenerator words(int words)

Description copied from interface: LoremIpsumGeneratorSpec

Number of words to generate. Default is LoremIpsumGeneratorSpec.DEFAULT_WORDS.

Specified by:

words in interface LoremIpsumGeneratorSpec

Specified by:

words in interface LoremIpsumSpec

Returns:

spec builder

paragraphs

public LoremIpsumGenerator paragraphs(int paragraphs)

Description copied from interface: LoremIpsumGeneratorSpec

Number of paragraphs to generate. Default is LoremIpsumGeneratorSpec.DEFAULT_PARAGRAPHS.

Specified by:

paragraphs in interface LoremIpsumGeneratorSpec

Specified by:

paragraphs in interface LoremIpsumSpec

Returns:

spec builder

nullable

public LoremIpsumGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface LoremIpsumSpec

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