Package org.instancio.generator.specs

Interface StringSpec

All Superinterfaces:

GeneratorSpec<String>, NullableGeneratorSpec<String>, StringGeneratorSpec, Supplier<String>, 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, uppercase by default, that consists of characters [0-9A-Z].
StringSpec	digits()	Generates a string that consists of digits [0-9].
StringSpec	hex()	Generates a hexadecimal string, uppercase by default, that consists of characters [0-9A-F]
StringSpec	length(int length)	Specifies the length of the string to generate as returned by String.length(), or the number of code points when generating a StringGeneratorSpec.unicode(UnicodeBlock...) string.
StringSpec	length(int minLength, int maxLength)	Specifies the length of the string to generate as returned by String.length(), or the number of code points when generating a StringGeneratorSpec.unicode(UnicodeBlock...) string.
StringSpec	lowerCase()	Generates a lowercase string that consists of characters [a-z].
StringSpec	maxLength(int length)	Specifies the maximum length of the string to generate as returned by String.length(), or the number of code points when generating a StringGeneratorSpec.unicode(UnicodeBlock...) string.
StringSpec	minLength(int length)	Specifies the minimum length of the string to generate as returned by String.length(), or the number of code points when generating a StringGeneratorSpec.unicode(UnicodeBlock...) string.
StringSpec	mixedCase()	Generates a string that consists of characters [A-Za-z].
StringSpec	nullable()	Specifies that a null value can be generated
StringSpec	numericSequence()	Generates a string sequence that starts from "1" and increments by one.
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	unicode(Character.UnicodeBlock... blocks)	Generates a Unicode string that consists of random code points excluding the following character types: Character.PRIVATE_USE Character.SURROGATE Character.UNASSIGNED
StringSpec	upperCase()	Generates an uppercase string that consists of characters [A-Z].

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream

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

Specifies the length of the string to generate as returned by String.length(), or the number of code points when generating a StringGeneratorSpec.unicode(UnicodeBlock...) string.

This method has no effect if StringGeneratorSpec.numericSequence() is specified.

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

Specifies the length of the string to generate as returned by String.length(), or the number of code points when generating a StringGeneratorSpec.unicode(UnicodeBlock...) string.

This method has no effect if StringGeneratorSpec.numericSequence() is specified.

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

Specifies the minimum length of the string to generate as returned by String.length(), or the number of code points when generating a StringGeneratorSpec.unicode(UnicodeBlock...) string.

This method has no effect if StringGeneratorSpec.numericSequence() is specified.

Specified by:

minLength in interface StringGeneratorSpec

Parameters:

length - minimum length (inclusive)

Returns:

spec builder

maxLength

StringSpec maxLength(int length)

Description copied from interface: StringGeneratorSpec

Specifies the maximum length of the string to generate as returned by String.length(), or the number of code points when generating a StringGeneratorSpec.unicode(UnicodeBlock...) string.

This method has no effect if StringGeneratorSpec.numericSequence() is specified.

Specified by:

maxLength in interface StringGeneratorSpec

Parameters:

length - maximum length (inclusive)

Returns:

spec builder

lowerCase

StringSpec lowerCase()

Description copied from interface: StringGeneratorSpec

Generates a lowercase string that consists of characters [a-z].

Note: this method has no effect when used with any of the following methods:

• StringGeneratorSpec.digits()
• StringGeneratorSpec.numericSequence()
• StringGeneratorSpec.unicode(UnicodeBlock...)

Specified by:

lowerCase in interface StringGeneratorSpec

Returns:

spec builder

upperCase

StringSpec upperCase()

Description copied from interface: StringGeneratorSpec

Generates an uppercase string that consists of characters [A-Z].

Note: this method has no effect when used with any of the following methods:

• StringGeneratorSpec.digits()
• StringGeneratorSpec.numericSequence()
• StringGeneratorSpec.unicode(UnicodeBlock...)

Specified by:

upperCase in interface StringGeneratorSpec

Returns:

spec builder

mixedCase

StringSpec mixedCase()

Description copied from interface: StringGeneratorSpec

Generates a string that consists of characters [A-Za-z].

Note: this method has no effect when used with any of the following methods:

• StringGeneratorSpec.digits()
• StringGeneratorSpec.numericSequence()
• StringGeneratorSpec.unicode(UnicodeBlock...)

Specified by:

mixedCase in interface StringGeneratorSpec

Returns:

spec builder

alphaNumeric

StringSpec alphaNumeric()

Description copied from interface: StringGeneratorSpec

Generates an alphanumeric string, uppercase by default, that consists of characters [0-9A-Z].

The equivalent Keys.STRING_TYPE setting is StringType.ALPHANUMERIC.

Specified by:

alphaNumeric in interface StringGeneratorSpec

Returns:

spec builder

See Also:

• StringGeneratorSpec.upperCase()
• StringGeneratorSpec.lowerCase()
• StringGeneratorSpec.mixedCase()

digits

StringSpec digits()

Description copied from interface: StringGeneratorSpec

Generates a string that consists of digits [0-9].

The equivalent Keys.STRING_TYPE setting is StringType.DIGITS.

Specified by:

digits in interface StringGeneratorSpec

Returns:

spec builder

hex

StringSpec hex()

Generates a hexadecimal string, uppercase by default, that consists of characters [0-9A-F]

The equivalent Keys.STRING_TYPE setting is StringType.HEX.

Specified by:

hex in interface StringGeneratorSpec

Returns:

spec builder

Since:

2.11.0

See Also:

• StringGeneratorSpec.upperCase()
• StringGeneratorSpec.lowerCase()
• StringGeneratorSpec.mixedCase()

numericSequence

StringSpec numericSequence()

Generates a string sequence that starts from "1" and increments by one.

The equivalent Keys.STRING_TYPE setting is StringType.NUMERIC_SEQUENCE.

Specified by:

numericSequence in interface StringGeneratorSpec

Returns:

spec builder

Since:

4.7.0

unicode

@ExperimentalApi
StringSpec unicode(Character.UnicodeBlock... blocks)

Generates a Unicode string that consists of random code points excluding the following character types:

• Character.PRIVATE_USE
• Character.SURROGATE
• Character.UNASSIGNED

This method accepts an optional vararg of Character.UnicodeBlock objects. If no unicodeBlocks are specified, code points will be generated from the range [0..0x3FFFF], for example:

 Comment comment = Instancio.of(Comment.class)
     .generate(field(Comment::getText), gen -> gen.string().unicode().length(10))
     .create();

 // Sample output:
 // Comment[text="𪬨鉢𓉰埗ᮓ웝𤈱恼棭騜"]
 

If unicodeBlocks are specified, code points will be chosen from the given Unicode blocks:

 Character.UnicodeBlock[] blocks = { Character.UnicodeBlock.EMOTICONS, Character.UnicodeBlock.CYRILLIC };

 Comment comment = Instancio.of(Comment.class)
     .generate(field(Comment::getText), gen -> gen.string().length(10).unicode(blocks))
     .create();

 // Sample output:
 // Comment[text="ф😬😅😟фҖӝ😲ЭӍ"]
 

The equivalent Keys.STRING_TYPE setting is StringType.UNICODE.

Specified by:

unicode in interface StringGeneratorSpec

Parameters:

blocks - Unicode blocks to use when generating strings, or no argument to generate code points from random blocks

Returns:

spec builder

Since:

4.7.0