Package org.instancio.generator.lang
Class StringGenerator
- java.lang.Object
-
- org.instancio.generator.AbstractRandomGenerator<String>
-
- org.instancio.generator.lang.StringGenerator
-
- All Implemented Interfaces:
Generator<String>
,GeneratorSpec<String>
,StringGeneratorSpec
public class StringGenerator extends AbstractRandomGenerator<String> implements StringGeneratorSpec
-
-
Constructor Summary
Constructors Constructor Description StringGenerator(GeneratorContext context)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringGeneratorSpec
allowEmpty()
Indicates that an empty string can be generated.String
generate()
Returns a generated value.GeneratedHints
getHints()
Returns hints, including collection sizes and whether values are nullable.StringGeneratorSpec
maxLength(int length)
Maximum length of string to generate.StringGeneratorSpec
minLength(int length)
Minimum length of string to generate.StringGeneratorSpec
nullable()
Indicates thatnull
value can be generated.StringGeneratorSpec
prefix(String prefix)
Specifies a String prefix.-
Methods inherited from class org.instancio.generator.AbstractRandomGenerator
getContext, random
-
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
isDelegating, setDelegate, targetClass
-
-
-
-
Constructor Detail
-
StringGenerator
public StringGenerator(GeneratorContext context)
-
-
Method Detail
-
prefix
public StringGeneratorSpec prefix(String prefix)
Description copied from interface:StringGeneratorSpec
Specifies a String prefix.- Specified by:
prefix
in interfaceStringGeneratorSpec
- Parameters:
prefix
- for generated strings- Returns:
- spec builder
-
allowEmpty
public StringGeneratorSpec allowEmpty()
Description copied from interface:StringGeneratorSpec
Indicates that an empty string can be generated.- Specified by:
allowEmpty
in interfaceStringGeneratorSpec
- Returns:
- spec builder
-
nullable
public StringGeneratorSpec nullable()
Description copied from interface:StringGeneratorSpec
Indicates thatnull
value can be generated.- Specified by:
nullable
in interfaceStringGeneratorSpec
- Returns:
- spec builder
-
minLength
public StringGeneratorSpec minLength(int length)
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
public StringGeneratorSpec maxLength(int length)
Description copied from interface:StringGeneratorSpec
Maximum length of string to generate.- Specified by:
maxLength
in interfaceStringGeneratorSpec
- Parameters:
length
- maximum length (inclusive)- Returns:
- spec builder
-
generate
public String generate()
Description copied from interface:Generator
Returns a generated value. By default, generated values are random.Generation parameters for common types such as strings, numbers, collections, etc. can be customised by passing in custom generators.
-
getHints
public GeneratedHints getHints()
Description copied from interface:Generator
Returns hints, including collection sizes and whether values are nullable.
-
-