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>
-
Field Summary
-
Constructor Summary
-
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.Returns the public API method name of the generator spec.digits()
Generates a string comprised of only digits.final int
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()
Indicates thatnull
value can be generated.nullable
(boolean isNullable) Specifies the prefix to prepend to generated strings.void
setDelegate
(Generator<?> delegate) Specifies the suffix to append to generated strings.tryGenerateNonNull
(Random random) Makes the best effort to return a non-null value.Generates an upper case string.Methods inherited from class org.instancio.internal.generator.AbstractGenerator
generate, getContext, hints, isNullable
-
Field Details
-
minLength
protected int minLength -
maxLength
protected int maxLength
-
-
Constructor Details
-
StringGenerator
public StringGenerator() -
StringGenerator
-
-
Method Details
-
setDelegate
-
getMinLength
public final int getMinLength() -
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 classAbstractGenerator<String>
- Returns:
- spec name if defined, or
null
otherwise
-
prefix
Description copied from interface:StringGeneratorSpec
Specifies the prefix to prepend to generated strings.- Specified by:
prefix
in interfaceStringGeneratorSpec
- Specified by:
prefix
in interfaceStringSpec
- 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
- Specified by:
suffix
in interfaceStringSpec
- Parameters:
suffix
- for generated strings- Returns:
- spec builder
-
allowEmpty
Description copied from interface:StringGeneratorSpec
Indicates that an empty string can be generated.- Specified by:
allowEmpty
in interfaceStringGeneratorSpec
- Specified by:
allowEmpty
in interfaceStringSpec
- Returns:
- spec builder
-
allowEmpty
Description copied from interface:StringGeneratorSpec
Indicates if empty string can be generated.- Specified by:
allowEmpty
in interfaceStringGeneratorSpec
- Specified by:
allowEmpty
in interfaceStringSpec
- Parameters:
isAllowed
- iftrue
, empty strings can be generated- Returns:
- spec builder
-
nullable
Description copied from interface:NullableGeneratorSpec
Indicates thatnull
value can be generated.- Specified by:
nullable
in interfaceNullableGeneratorSpec<String>
- Specified by:
nullable
in interfaceStringGeneratorSpec
- Specified by:
nullable
in interfaceStringSpec
- Specified by:
nullable
in interfaceValueSpec<String>
- Overrides:
nullable
in classAbstractGenerator<String>
- Returns:
- spec builder
-
nullable
- Overrides:
nullable
in classAbstractGenerator<String>
-
length
Description copied from interface:StringGeneratorSpec
Length of string to generate.- Specified by:
length
in interfaceStringGeneratorSpec
- Specified by:
length
in interfaceStringSpec
- 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
- Specified by:
length
in interfaceStringSpec
- 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
- Specified by:
minLength
in interfaceStringSpec
- 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
- Specified by:
maxLength
in interfaceStringSpec
- Parameters:
length
- maximum length (inclusive)- Returns:
- spec builder
-
lowerCase
Description copied from interface:StringGeneratorSpec
Generates a lower case string.- Specified by:
lowerCase
in interfaceStringGeneratorSpec
- Specified by:
lowerCase
in interfaceStringSpec
- Returns:
- spec builder
-
upperCase
Description copied from interface:StringGeneratorSpec
Generates an upper case string.- Specified by:
upperCase
in interfaceStringGeneratorSpec
- Specified by:
upperCase
in interfaceStringSpec
- Returns:
- spec builder
-
mixedCase
Description copied from interface:StringGeneratorSpec
Generates a mixed case string.- Specified by:
mixedCase
in interfaceStringGeneratorSpec
- Specified by:
mixedCase
in interfaceStringSpec
- Returns:
- spec builder
-
alphaNumeric
Description copied from interface:StringGeneratorSpec
Generates an alphanumeric string, upper case by default.- Specified by:
alphaNumeric
in interfaceStringGeneratorSpec
- Specified by:
alphaNumeric
in interfaceStringSpec
- Returns:
- spec builder
-
digits
Description copied from interface:StringGeneratorSpec
Generates a string comprised of only digits.- Specified by:
digits
in interfaceStringGeneratorSpec
- Specified by:
digits
in interfaceStringSpec
- Returns:
- spec builder
-
hex
Description copied from interface:StringSpec
Generates a hexadecimal string, upper case by default.- Specified by:
hex
in interfaceStringGeneratorSpec
- Specified by:
hex
in interfaceStringSpec
- Returns:
- spec builder
-
tryGenerateNonNull
Description copied from class:AbstractGenerator
Makes the best effort to return a non-null value. However, in certain cases this method will produce anull
.- Specified by:
tryGenerateNonNull
in classAbstractGenerator<String>
- Parameters:
random
- for generating the value- Returns:
- generated value, either a null or non-null
-