Package org.instancio.generator.specs
Interface StringSpec
- All Superinterfaces:
GeneratorSpec<String>
,NullableGeneratorSpec<String>
,StringGeneratorSpec
,ValueSpec<String>
- All Known Implementing Classes:
StringGenerator
Spec for generating
String
values.- Since:
- 2.6.0
-
Method Summary
Modifier and TypeMethodDescriptionIndicates that an empty string can be generated.allowEmpty
(boolean isAllowed) Indicates if empty string can be generated.Generates an alphanumeric string, upper case by default.digits()
Generates a string comprised of only digits.hex()
Generates a hexadecimal string, upper case by default.length
(int length) Length of string to generate.length
(int minLength, int maxLength) Length of string to generate.Generates a lower case string.maxLength
(int length) Maximum length of string to generate.minLength
(int length) Minimum length of string to generate.Generates a mixed case string.nullable()
Specifies that anull
value can be generatedSpecifies the prefix to prepend to generated strings.Specifies the suffix to append to generated strings.Generates an upper case string.
-
Method Details
-
prefix
Description copied from interface:StringGeneratorSpec
Specifies the prefix to prepend to generated strings.- Specified by:
prefix
in interfaceStringGeneratorSpec
- Parameters:
prefix
- for generated strings- Returns:
- spec builder
-
suffix
Description copied from interface:StringGeneratorSpec
Specifies the suffix to append to generated strings.- Specified by:
suffix
in interfaceStringGeneratorSpec
- Parameters:
suffix
- for generated strings- Returns:
- spec builder
-
nullable
StringSpec nullable()Description copied from interface:ValueSpec
Specifies that anull
value can be generated- Specified by:
nullable
in interfaceNullableGeneratorSpec<String>
- Specified by:
nullable
in interfaceStringGeneratorSpec
- Specified by:
nullable
in interfaceValueSpec<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 interfaceStringGeneratorSpec
- Returns:
- spec builder
-
allowEmpty
Description copied from interface:StringGeneratorSpec
Indicates if empty string can be generated.- Specified by:
allowEmpty
in interfaceStringGeneratorSpec
- Parameters:
isAllowed
- iftrue
, empty strings can be generated- Returns:
- spec builder
-
length
Description copied from interface:StringGeneratorSpec
Length of string to generate.- Specified by:
length
in interfaceStringGeneratorSpec
- Parameters:
length
- exact length to generate- Returns:
- spec builder
-
length
Description copied from interface:StringGeneratorSpec
Length of string to generate.- Specified by:
length
in interfaceStringGeneratorSpec
- Parameters:
minLength
- minimum length (inclusive)maxLength
- maximum length (inclusive)- Returns:
- spec builder
-
minLength
Description copied from interface:StringGeneratorSpec
Minimum length of string to generate.- Specified by:
minLength
in interfaceStringGeneratorSpec
- Parameters:
length
- minimum length (inclusive)- Returns:
- spec builder
-
maxLength
Description copied from interface:StringGeneratorSpec
Maximum length of string to generate.- Specified by:
maxLength
in interfaceStringGeneratorSpec
- 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 interfaceStringGeneratorSpec
- Returns:
- spec builder
-
upperCase
StringSpec upperCase()Description copied from interface:StringGeneratorSpec
Generates an upper case string.- Specified by:
upperCase
in interfaceStringGeneratorSpec
- Returns:
- spec builder
-
mixedCase
StringSpec mixedCase()Description copied from interface:StringGeneratorSpec
Generates a mixed case string.- Specified by:
mixedCase
in interfaceStringGeneratorSpec
- Returns:
- spec builder
-
alphaNumeric
StringSpec alphaNumeric()Description copied from interface:StringGeneratorSpec
Generates an alphanumeric string, upper case by default.- Specified by:
alphaNumeric
in interfaceStringGeneratorSpec
- Returns:
- spec builder
-
digits
StringSpec digits()Description copied from interface:StringGeneratorSpec
Generates a string comprised of only digits.- Specified by:
digits
in interfaceStringGeneratorSpec
- Returns:
- spec builder
-
hex
StringSpec hex()Generates a hexadecimal string, upper case by default.- Specified by:
hex
in interfaceStringGeneratorSpec
- Returns:
- spec builder
- Since:
- 2.11.0
-