Uses of Interface
org.instancio.generator.GeneratorSpec

Packages that use GeneratorSpec

Package	Description
org.instancio	Instancio public-facing APIs; for usage examples see Instancio.
org.instancio.generator	Contains classes related to generators.
org.instancio.generator.specs	Defines generator specs.
org.instancio.generator.specs.can	Defines generator specs for Canada.
org.instancio.generator.specs.pol	Defines generator specs for Poland.
org.instancio.generator.specs.usa	Defines generator specs for USA.
org.instancio.spi	Defines Service Provider Interfaces for providing custom implementations.

Uses of GeneratorSpec in org.instancio

Methods in org.instancio that return GeneratorSpec

Modifier and Type	Method	Description
GeneratorSpec<V>	GeneratorSpecProvider.getSpec(Generators gen)	Returns a customised generator spec.

Methods in org.instancio with parameters of type GeneratorSpec

Modifier and Type	Method	Description
<T> Assignment	GivenOriginDestinationAction.elseGenerate(GeneratorSpec<T> spec)	Generates values using arbitrary generator specs.
<V> CartesianProductApi<T>	CartesianProductApi.generate(TargetSelector selector, GeneratorSpec<V> spec)	Customises values using arbitrary generator specs.
<S, T> GivenOriginDestinationAction	GivenOriginDestination.generate(Predicate<S> predicate, GeneratorSpec<T> spec)	Generates values using arbitrary generator specs.
<T> GivenOriginPredicateAction	GivenOriginPredicate.generate(TargetSelector selector, GeneratorSpec<T> spec)	Generates values using arbitrary generator specs.
<V> InstancioApi<T>	InstancioApi.generate(TargetSelector selector, GeneratorSpec<V> spec)	Customises values using arbitrary generator specs.
<V> InstancioOperations<T>	InstancioOperations.generate(TargetSelector selector, GeneratorSpec<V> spec)	Customises values using arbitrary generator specs.
<T> Assignment	ValueOf.generate(GeneratorSpec<T> spec)	Generates values using arbitrary generator specs.

Uses of GeneratorSpec in org.instancio.generator

Subinterfaces of GeneratorSpec in org.instancio.generator

Modifier and Type	Interface	Description
interface	Generator<T>	A class for generating values of a specific type.
interface	ValueSpec<T>	A spec for generating simple value types, such as strings, numbers, dates, and so on.

Uses of GeneratorSpec in org.instancio.generator.specs

Subinterfaces of GeneratorSpec in org.instancio.generator.specs

Modifier and Type	Interface	Description
interface	ArrayGeneratorSpec<T>	Generator spec for arrays.
interface	AsGeneratorSpec<T>	Allows mapping the result of a generator to another type.
interface	BigDecimalAsGeneratorSpec	Generator spec for BigDecimal values that supports AsGeneratorSpec.
interface	BigDecimalGeneratorSpec	Generator spec for BigDecimal.
interface	BigDecimalSpec	Spec for generating BigDecimal values.
interface	BigIntegerSpec	Spec for generating BigInteger values.
interface	BooleanAsGeneratorSpec	Generator spec for Boolean values that supports AsGeneratorSpec.
interface	BooleanGeneratorSpec	Generator spec for booleans.
interface	BooleanSpec	Spec for generating Boolean values.
interface	ByteSpec	Spec for generating Byte values.
interface	CharacterAsGeneratorSpec	Generator spec for Character values that supports AsGeneratorSpec.
interface	CharacterGeneratorSpec	Generator spec for characters.
interface	CharacterSpec	Spec for generating Character values.
interface	CollectionGeneratorSpec<T>	Generator spec for collections.
interface	CoordinateGeneratorSpec	Spec for generating coordinate values.
interface	CoordinateSpec	Spec for generating spatial coordinate values.
interface	CreditCardGeneratorSpec	Spec for generating credit card numbers.
interface	CreditCardSpec	Spec for generating credit card numbers.
interface	CsvGeneratorSpec	Generator spec for producing CSV.
interface	CsvSpec	Spec for generating CSV.
interface	DoubleSpec	Spec for generating Double values.
interface	DurationGeneratorSpec	Generator spec for Duration.
interface	DurationSpec	Spec for generating Duration.
interface	EanGeneratorSpec	Spec for generating European Article Number (EAN).
interface	EanSpec	Spec for generating European Article Number (EAN).
interface	EmailAsGeneratorSpec	Spec for generating email addresses that supports AsGeneratorSpec.
interface	EmailGeneratorSpec	Spec for generating email addresses.
interface	EmailSpec	Spec for generating email addresses.
interface	EmitGeneratorSpec<T>	A generator spec that emits given items to a selector's target.
interface	EnumAsGeneratorSpec<E extends Enum<E>>	Spec for Enums that supports AsGeneratorSpec.
interface	EnumGeneratorSpec<E extends Enum<E>>	Generator spec for Enums.
interface	EnumSetGeneratorSpec<E extends Enum<E>>	Generator spec for EnumSet.
interface	EnumSpec<E extends Enum<E>>	Spec for generating enums.
interface	FilePathSpec<T>	Spec for generating File and Path values.
interface	FileSpec	Spec for generating File values.
interface	FloatSpec	Spec for generating Float values.
interface	HashAsGeneratorSpec	Spec for generating hashes that supports AsGeneratorSpec.
interface	HashGeneratorSpec	Spec for generating hashes
interface	HashSpec	Spec for generating hashes
interface	InstantGeneratorAsSpec	Generator spec for Instant.
interface	InstantSpec	Spec for generating Instant values.
interface	IntegerSpec	Spec for generating Integer values.
interface	Ip4GeneratorSpec	Generator spec for IPv4.
interface	Ip4Spec	Spec for generating IPv4 addresses.
interface	IsbnGeneratorSpec	Spec for generating ISBN.
interface	IsbnSpec	Spec for generating ISBN.
interface	LocalDateSpec	Spec for generating LocalDate values.
interface	LocalDateTimeGeneratorAsSpec	Generator spec for LocalDateTime.
interface	LocalDateTimeSpec	Spec for generating LocalDateTime values.
interface	LocalTimeGeneratorAsSpec	Generator spec for LocalTime.
interface	LocalTimeSpec	Spec for generating LocalTime values.
interface	LongSpec	Spec for generating Long values.
interface	LoremIpsumGeneratorSpec	Generator spec for producing "Lorem ipsum..." text.
interface	LoremIpsumSpec	Spec for generating "lorem ipsum" text.
interface	LuhnAsGeneratorSpec	A spec for generating numbers that pass the Luhn checksum algorithm.
interface	LuhnGeneratorSpec	A spec for generating numbers that pass the Luhn checksum algorithm.
interface	LuhnSpec	A spec for generating numbers that pass the Luhn checksum algorithm.
interface	MapGeneratorSpec<K,V>	Generator spec for maps.
interface	Mod10AsGeneratorSpec	A spec for generating numbers that pass the Mod10 checksum algorithm.
interface	Mod10GeneratorSpec	A spec for generating numbers that pass the Mod10 checksum algorithm.
interface	Mod10Spec	A spec for generating numbers that pass the Mod10 checksum algorithm.
interface	Mod11AsGeneratorSpec	A spec for generating numbers that pass the Mod11 checksum algorithm.
interface	Mod11GeneratorSpec	A spec for generating numbers that pass the Mod11 checksum algorithm.
interface	Mod11Spec	A spec for generating numbers that pass the Mod11 checksum algorithm.
interface	MonthDayGeneratorSpec	Generator spec for MonthDay types.
interface	NullableGeneratorSpec<T>	Provides methods for specifying whether null can be generated.
interface	NumberAsGeneratorSpec<T extends Number>	Generator spec for Number types that supports AsGeneratorSpec.
interface	NumberGeneratorSpec<T extends Number>	Generator spec for numeric types.
interface	NumberSpec<T extends Number>	Spec for generating Number types.
interface	NumericSequenceAsGeneratorSpec<T extends Number & Comparable<T>>	A spec for generating numeric sequences that supports AsGeneratorSpec.
interface	NumericSequenceGeneratorSpec<T extends Number & Comparable<T>>	A spec for generating numeric sequences.
interface	NumericSequenceSpec<T extends Number & Comparable<T>>	Spec for generating numeric sequences.
interface	OffsetDateTimeGeneratorAsSpec	Generator spec for OffsetDateTime.
interface	OffsetDateTimeSpec	Spec for generating OffsetDateTime values.
interface	OffsetTimeGeneratorAsSpec	Generator spec for OffsetTime.
interface	OffsetTimeSpec	Spec for generating OffsetTime values.
interface	OneOfArrayGeneratorSpec<T>	Generator spec for selecting a random value from an array.
interface	OneOfArraySpec<T>	Spec for selecting a random value from an array.
interface	OneOfCollectionGeneratorSpec<T>	Generator spec for selecting a random value from collection.
interface	OneOfCollectionSpec<T>	Spec for selecting a random value from a collection.
interface	OptionalGeneratorSpec<T>	Generator spec for Optional.
interface	PathAsGeneratorSpec<T>	Generator spec for path values that supports AsGeneratorSpec.
interface	PathGeneratorSpec<T>	Generator spec for customising Files and Paths.
interface	PathSpec	Spec for generating Path values.
interface	PeriodGeneratorSpec	Generator spec for Period.
interface	PeriodSpec	Spec for generating Period.
interface	ShortSpec	Spec for generating Short values.
interface	SizeGeneratorSpec<T>	Generator spec for specifying the size of an object.
interface	StringGeneratorSpec	Generator spec for Strings.
interface	StringSpec	Spec for generating String values.
interface	SubtypeGeneratorSpec<T>	Provides a method for specifying a specific subtype that should be generated.
interface	TemporalAsGeneratorSpec<T>	Generator spec for temporal values that supports AsGeneratorSpec.
interface	TemporalGeneratorSpec<T>	Generator spec for Temporal types.
interface	TemporalSpec<T>	Spec for generating Temporal types.
interface	TextPatternAsGeneratorSpec	Generator spec for text patterns that supports AsGeneratorSpec.
interface	TextPatternGeneratorSpec	Spec for generating strings based on a pattern.
interface	TextPatternSpec	Spec for generating strings based on a pattern.
interface	TruncatableTemporalSpec<T>	A spec for truncating temporal values.
interface	URIAsGeneratorSpec	Generator spec for URI values that supports AsGeneratorSpec.
interface	URIGeneratorSpec	Generator spec for URI.
interface	URISpec	Spec for generating URI values.
interface	URLAsGeneratorSpec	Generator spec for URL values that supports AsGeneratorSpec.
interface	URLGeneratorSpec	Generator spec for URL.
interface	URLSpec	Spec for generating URL values.
interface	UUIDSpec	Spec for generating UUID values.
interface	UUIDStringGeneratorSpec	Generator spec for generating UUID strings.
interface	UUIDStringSpec	Spec for generating string representations of UUID values.
interface	YearMonthSpec	Spec for generating YearMonth values.
interface	YearSpec	Spec for generating Year values.
interface	ZonedDateTimeGeneratorAsSpec	Generator spec for ZonedDateTime.
interface	ZonedDateTimeSpec	Spec for generating ZonedDateTime values.

Methods in org.instancio.generator.specs that return GeneratorSpec

Modifier and Type	Method	Description
GeneratorSpec<Optional<T>>	OptionalGeneratorSpec.allowEmpty()	Specifies that an empty Optional can be generated.
default <R> GeneratorSpec<R>	AsGeneratorSpec.as(Function<T,R> mappingFunction)	Converts the generated value to another type using the specified mapping function.
default GeneratorSpec<String>	AsGeneratorSpec.asString()	Converts the generated value to a String.
GeneratorSpec<T>	PathAsGeneratorSpec.createDirectory()
GeneratorSpec<T>	PathGeneratorSpec.createDirectory()	Terminal method to indicate that the generated path, including parent directories (if any), should be created as a directory in the file system.
GeneratorSpec<T>	PathAsGeneratorSpec.createFile()
GeneratorSpec<T>	PathAsGeneratorSpec.createFile(InputStream content)
GeneratorSpec<T>	PathGeneratorSpec.createFile()	Terminal method to indicate that the generated path, including parent directories (if any), should be created as a file in the file system.
GeneratorSpec<T>	PathGeneratorSpec.createFile(InputStream content)	Terminal method to indicate that the generated path, including parent directories (if any), should be created as a file in the file system and content provided by the input stream written to the file.
GeneratorSpec<String>	Ip4GeneratorSpec.fromCidr(String cidr)	Generates IPv4 address from CIDR notation, for example: fromCidr("192.168.1.0/24").
GeneratorSpec<T>	NullableGeneratorSpec.nullable()	Indicates that null value can be generated.
GeneratorSpec<String>	UUIDStringGeneratorSpec.nullable()	Indicates that null value can be generated.
GeneratorSpec<T>	OneOfArrayGeneratorSpec.oneOf(T... values)	Selects a random value from the given choices.
GeneratorSpec<T>	OneOfCollectionGeneratorSpec.oneOf(Collection<T> values)	Selects a random value from the given choices.
GeneratorSpec<T>	TruncatableTemporalSpec.truncatedTo(TemporalUnit unit)	Truncates generated values to the specified unit.

Methods in org.instancio.generator.specs with parameters of type GeneratorSpec

Modifier and Type	Method	Description
CsvGeneratorSpec	CsvGeneratorSpec.column(String name, GeneratorSpec<?> generatorSpec)	Specifies the column name and the generator spec for producing the values.
CsvSpec	CsvSpec.column(String name, GeneratorSpec<?> generatorSpec)

Uses of GeneratorSpec in org.instancio.generator.specs.can

Subinterfaces of GeneratorSpec in org.instancio.generator.specs.can

Modifier and Type	Interface	Description
interface	SinAsGeneratorSpec	Spec for generating Canadian Social Insurance Number (SIN) that supports AsGeneratorSpec.
interface	SinGeneratorSpec	Spec for generating Canadian Social Insurance Number (SIN).
interface	SinSpec	Spec for generating Canadian Social Insurance Number (SIN).

Uses of GeneratorSpec in org.instancio.generator.specs.pol

Subinterfaces of GeneratorSpec in org.instancio.generator.specs.pol

Modifier and Type	Interface	Description
interface	NipGeneratorSpec	Spec for generating Polish VAT Identification Number (NIP).
interface	NipSpec	Spec for generating Polish VAT Identification Number (NIP).
interface	PeselGeneratorSpec	Spec for generating Polish National Identification Number (PESEL).
interface	PeselSpec	Spec for generating Polish National Identification Number (PESEL).
interface	RegonGeneratorSpec	Spec for generating Polish Taxpayer Identification Number (REGON).
interface	RegonSpec	Spec for generating Polish Taxpayer Identification Number (REGON).

Uses of GeneratorSpec in org.instancio.generator.specs.usa

Subinterfaces of GeneratorSpec in org.instancio.generator.specs.usa

Modifier and Type	Interface	Description
interface	SsnGeneratorSpec	Spec for generating US Social Security Number (SSN).
interface	SsnSpec	Spec for generating US Social Security Number (SSN).

Uses of GeneratorSpec in org.instancio.spi

Methods in org.instancio.spi that return GeneratorSpec

Modifier and Type	Method	Description
GeneratorSpec<?>	InstancioServiceProvider.GeneratorProvider.getGenerator(Node node, Generators generators)	Returns a generator spec for the specified node.