Package org.instancio.internal.generator.lang

Class StringGenerator

java.lang.Object

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

org.instancio.internal.generator.lang.StringGenerator

All Implemented Interfaces:

Generator<String>, GeneratorSpec<String>, NullableGeneratorSpec<String>, StringGeneratorSpec, StringSpec, ValueSpec<String>

public class StringGenerator
extends AbstractGenerator<String>
implements StringSpec

Field Summary

Fields

Modifier and Type	Field	Description
protected int	maxLength
protected int	minLength

Constructor Summary

Constructors

Constructor	Description
StringGenerator()
StringGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
StringGenerator	allowEmpty()	Indicates that an empty string can be generated.
StringSpec	allowEmpty(boolean isAllowed)	Indicates if empty string can be generated.
StringGenerator	alphaNumeric()	Generates an alphanumeric string, upper case by default.
String	apiMethod()	Returns the public API method name of the generator spec.
StringGenerator	digits()	Generates a string comprised of only digits.
final int	getMinLength()
StringGenerator	hex()	Generates a hexadecimal string, upper case by default.
StringGenerator	length(int length)	Length of string to generate.
StringGenerator	length(int minLength, int maxLength)	Length of string to generate.
StringGenerator	lowerCase()	Generates a lower case string.
StringGenerator	maxLength(int length)	Maximum length of string to generate.
StringGenerator	minLength(int length)	Minimum length of string to generate.
StringGenerator	mixedCase()	Generates a mixed case string.
StringGenerator	nullable()	Indicates that null value can be generated.
StringGenerator	nullable(boolean isNullable)
StringGenerator	prefix(String prefix)	Specifies the prefix to prepend to generated strings.
void	setDelegate(Generator<?> delegate)
StringGenerator	suffix(String suffix)	Specifies the suffix to append to generated strings.
String	tryGenerateNonNull(Random random)	Makes the best effort to return a non-null value.
StringGenerator	upperCase()	Generates an upper case string.

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

get, list, map, stream, toModel

Field Details

minLength

protected int minLength

maxLength

protected int maxLength

Constructor Details

StringGenerator

public StringGenerator()

StringGenerator

public StringGenerator(GeneratorContext context)

Method Details

setDelegate

public void setDelegate(Generator<?> delegate)

getMinLength

public final int getMinLength()

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

prefix

public StringGenerator prefix(String prefix)

Description copied from interface: StringGeneratorSpec

Specifies the prefix to prepend to generated strings.

Specified by:

prefix in interface StringGeneratorSpec

Specified by:

prefix in interface StringSpec

Parameters:

prefix - for generated strings

Returns:

spec builder

suffix

public StringGenerator suffix(String suffix)

Description copied from interface: StringGeneratorSpec

Specifies the suffix to append to generated strings.

Specified by:

suffix in interface StringGeneratorSpec

Specified by:

suffix in interface StringSpec

Parameters:

suffix - for generated strings

Returns:

spec builder

allowEmpty

public StringGenerator allowEmpty()

Description copied from interface: StringGeneratorSpec

Indicates that an empty string can be generated.

Specified by:

allowEmpty in interface StringGeneratorSpec

Specified by:

allowEmpty in interface StringSpec

Returns:

spec builder

allowEmpty

public StringSpec allowEmpty(boolean isAllowed)

Description copied from interface: StringGeneratorSpec

Indicates if empty string can be generated.

Specified by:

allowEmpty in interface StringGeneratorSpec

Specified by:

allowEmpty in interface StringSpec

Parameters:

isAllowed - if true, empty strings can be generated

Returns:

spec builder

nullable

public StringGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<String>

Specified by:

nullable in interface StringGeneratorSpec

Specified by:

nullable in interface StringSpec

Specified by:

nullable in interface ValueSpec<String>

Overrides:

nullable in class AbstractGenerator<String>

Returns:

spec builder

nullable

public StringGenerator nullable(boolean isNullable)

Overrides:

nullable in class AbstractGenerator<String>

length

public StringGenerator length(int length)

Description copied from interface: StringGeneratorSpec

Length of string to generate.

Specified by:

length in interface StringGeneratorSpec

Specified by:

length in interface StringSpec

Parameters:

length - exact length to generate

Returns:

spec builder

length

public StringGenerator length(int minLength,
 int maxLength)

Description copied from interface: StringGeneratorSpec

Length of string to generate.

Specified by:

length in interface StringGeneratorSpec

Specified by:

length in interface StringSpec

Parameters:

minLength - minimum length (inclusive)

maxLength - maximum length (inclusive)

Returns:

spec builder

minLength

public StringGenerator minLength(int length)

Description copied from interface: StringGeneratorSpec

Minimum length of string to generate.

Specified by:

minLength in interface StringGeneratorSpec

Specified by:

minLength in interface StringSpec

Parameters:

length - minimum length (inclusive)

Returns:

spec builder

maxLength

public StringGenerator maxLength(int length)

Description copied from interface: StringGeneratorSpec

Maximum length of string to generate.

Specified by:

maxLength in interface StringGeneratorSpec

Specified by:

maxLength in interface StringSpec

Parameters:

length - maximum length (inclusive)

Returns:

spec builder

lowerCase

public StringGenerator lowerCase()

Description copied from interface: StringGeneratorSpec

Generates a lower case string.

Specified by:

lowerCase in interface StringGeneratorSpec

Specified by:

lowerCase in interface StringSpec

Returns:

spec builder

upperCase

public StringGenerator upperCase()

Description copied from interface: StringGeneratorSpec

Generates an upper case string.

Specified by:

upperCase in interface StringGeneratorSpec

Specified by:

upperCase in interface StringSpec

Returns:

spec builder

mixedCase

public StringGenerator mixedCase()

Description copied from interface: StringGeneratorSpec

Generates a mixed case string.

Specified by:

mixedCase in interface StringGeneratorSpec

Specified by:

mixedCase in interface StringSpec

Returns:

spec builder

alphaNumeric

public StringGenerator alphaNumeric()

Description copied from interface: StringGeneratorSpec

Generates an alphanumeric string, upper case by default.

Specified by:

alphaNumeric in interface StringGeneratorSpec

Specified by:

alphaNumeric in interface StringSpec

Returns:

spec builder

digits

public StringGenerator digits()

Description copied from interface: StringGeneratorSpec

Generates a string comprised of only digits.

Specified by:

digits in interface StringGeneratorSpec

Specified by:

digits in interface StringSpec

Returns:

spec builder

hex

public StringGenerator hex()

Description copied from interface: StringSpec

Generates a hexadecimal string, upper case by default.

Specified by:

hex in interface StringGeneratorSpec

Specified by:

hex in interface StringSpec

Returns:

spec builder

tryGenerateNonNull

public 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