Package org.instancio.generator.specs

Interface StringSpec

All Superinterfaces:

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

public interface StringSpec
extends ValueSpec<String>, StringGeneratorSpec

Spec for generating String values.

Since:

2.6.0

Method Summary

Modifier and Type	Method	Description
StringSpec	allowEmpty()	Indicates that an empty string can be generated.
StringSpec	allowEmpty(boolean isAllowed)	Indicates if empty string can be generated.
StringSpec	alphaNumeric()	Generates an alphanumeric string, upper case by default.
StringSpec	digits()	Generates a string comprised of only digits.
StringSpec	hex()	Generates a hexadecimal string, upper case by default.
StringSpec	length(int length)	Length of string to generate.
StringSpec	length(int minLength, int maxLength)	Length of string to generate.
StringSpec	lowerCase()	Generates a lower case string.
StringSpec	maxLength(int length)	Maximum length of string to generate.
StringSpec	minLength(int length)	Minimum length of string to generate.
StringSpec	mixedCase()	Generates a mixed case string.
StringSpec	nullable()	Specifies that a null value can be generated
StringSpec	prefix(String prefix)	Specifies the prefix to prepend to generated strings.
StringSpec	suffix(String suffix)	Specifies the suffix to append to generated strings.
StringSpec	upperCase()	Generates an upper case string.

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Method Details

prefix

StringSpec prefix(String prefix)

Description copied from interface: StringGeneratorSpec

Specifies the prefix to prepend to generated strings.

Specified by:

prefix in interface StringGeneratorSpec

Parameters:

prefix - for generated strings

Returns:

spec builder

suffix

StringSpec suffix(String suffix)

Description copied from interface: StringGeneratorSpec

Specifies the suffix to append to generated strings.

Specified by:

suffix in interface StringGeneratorSpec

Parameters:

suffix - for generated strings

Returns:

spec builder

nullable

StringSpec nullable()

Description copied from interface: ValueSpec

Specifies that a null value can be generated

Specified by:

nullable in interface NullableGeneratorSpec<String>

Specified by:

nullable in interface StringGeneratorSpec

Specified by:

nullable in interface ValueSpec<String>

Returns:

spec builder reference

allowEmpty

StringSpec allowEmpty()

Description copied from interface: StringGeneratorSpec

Indicates that an empty string can be generated.

Specified by:

allowEmpty in interface StringGeneratorSpec

Returns:

spec builder

allowEmpty

StringSpec allowEmpty(boolean isAllowed)

Description copied from interface: StringGeneratorSpec

Indicates if empty string can be generated.

Specified by:

allowEmpty in interface StringGeneratorSpec

Parameters:

isAllowed - if true, empty strings can be generated

Returns:

spec builder

length

StringSpec length(int length)

Description copied from interface: StringGeneratorSpec

Length of string to generate.

Specified by:

length in interface StringGeneratorSpec

Parameters:

length - exact length to generate

Returns:

spec builder

length

StringSpec length(int minLength,
 int maxLength)

Description copied from interface: StringGeneratorSpec

Length of string to generate.

Specified by:

length in interface StringGeneratorSpec

Parameters:

minLength - minimum length (inclusive)

maxLength - maximum length (inclusive)

Returns:

spec builder

minLength

StringSpec minLength(int length)

Description copied from interface: StringGeneratorSpec

Minimum length of string to generate.

Specified by:

minLength in interface StringGeneratorSpec

Parameters:

length - minimum length (inclusive)

Returns:

spec builder

maxLength

StringSpec maxLength(int length)

Description copied from interface: StringGeneratorSpec

Maximum length of string to generate.

Specified by:

maxLength in interface StringGeneratorSpec

Parameters:

length - maximum length (inclusive)

Returns:

spec builder

lowerCase

StringSpec lowerCase()

Description copied from interface: StringGeneratorSpec

Generates a lower case string.

Specified by:

lowerCase in interface StringGeneratorSpec

Returns:

spec builder

upperCase

StringSpec upperCase()

Description copied from interface: StringGeneratorSpec

Generates an upper case string.

Specified by:

upperCase in interface StringGeneratorSpec

Returns:

spec builder

mixedCase

StringSpec mixedCase()

Description copied from interface: StringGeneratorSpec

Generates a mixed case string.

Specified by:

mixedCase in interface StringGeneratorSpec

Returns:

spec builder

alphaNumeric

StringSpec alphaNumeric()

Description copied from interface: StringGeneratorSpec

Generates an alphanumeric string, upper case by default.

Specified by:

alphaNumeric in interface StringGeneratorSpec

Returns:

spec builder

digits

StringSpec digits()

Description copied from interface: StringGeneratorSpec

Generates a string comprised of only digits.

Specified by:

digits in interface StringGeneratorSpec

Returns:

spec builder

hex

StringSpec hex()

Generates a hexadecimal string, upper case by default.

Specified by:

hex in interface StringGeneratorSpec

Returns:

spec builder

Since:

2.11.0