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.generators	Defines classes that provide access to built-in generators.
org.instancio.internal	Contains internal classes implementing the core functionality of Instancio.
org.instancio.internal.beanvalidation	Contains internal classes for handling Bean Validation annotations.
org.instancio.internal.generator	Contains internal classes related to generators.
org.instancio.internal.generator.array	Provides array generators.
org.instancio.internal.generator.domain.finance	Provides finance-related generators.
org.instancio.internal.generator.domain.hash	Provides generators for various types of hashes.
org.instancio.internal.generator.domain.id	Provides generators for various types of identifiers.
org.instancio.internal.generator.domain.internet	Provides Internet-related generators.
org.instancio.internal.generator.io	Provides generators for java.io.* types.
org.instancio.internal.generator.lang	Provides generators for java.lang.* types.
org.instancio.internal.generator.math	Provides generators for java.math.* types.
org.instancio.internal.generator.misc	Miscellaneous generators.
org.instancio.internal.generator.net	Provides generators for java.net.* types.
org.instancio.internal.generator.nio.file	Provides generators for java.nio.file.* types.
org.instancio.internal.generator.specs	Contains internal generator specs.
org.instancio.internal.generator.sql	Provides generators for java.sql.* types.
org.instancio.internal.generator.text	Provides text generators.
org.instancio.internal.generator.time	Provides generators for java.time.* types.
org.instancio.internal.generator.util	Provides generators for java.util.* types.
org.instancio.internal.generator.util.concurrent.atomic	Provides generators for java.util.concurrent.atomic.* types.
org.instancio.internal.generator.xml	Provides generators for javax.xml.* types.
org.instancio.internal.util	Provides internal utility classes.
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
<V> InstancioApi<T>	InstancioApi.generate(TargetSelector selector, GeneratorSpec<V> spec)	Customises 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	AsStringGeneratorSpec<T>	Deprecated. use AsGeneratorSpec instead.
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.

Methods in org.instancio.generator that return GeneratorSpec

Modifier and Type	Method	Description
default GeneratorSpec<String>	AsStringGeneratorSpec.asString(Function<T,String> toStringFunction)	Deprecated. use AsGeneratorSpec.as(Function) method.

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	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	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	LocalDateTimeSpec	Spec for generating LocalDateTime values.
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	MapGeneratorSpec<K,V>	Generator spec for maps.
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	OffsetDateTimeSpec	Spec for generating OffsetDateTime values.
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	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	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	TemporalAaStringGeneratorSpec<T>	Generator spec for temporal values that supports AsStringGeneratorSpec.
interface	TemporalGeneratorSpec<T>	Generator spec for Temporal types.
interface	TemporalSpec<T>	Spec for generating Temporal types.
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	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	ZonedDateTimeSpec	Spec for generating ZonedDateTime values.

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

Modifier and Type	Method	Description
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>	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.

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.generators

Methods in org.instancio.generators that return GeneratorSpec

Modifier and Type	Method	Description
GeneratorSpec<String>	TextGenerators.pattern(String pattern)	Generates a random string based on the specified pattern template.

Uses of GeneratorSpec in org.instancio.internal

Methods in org.instancio.internal with parameters of type GeneratorSpec

Modifier and Type	Method	Description
<V> InstancioApi<T>	ApiImpl.generate(TargetSelector selector, GeneratorSpec<V> spec)
void	GeneratorSpecProcessor.process(@NotNull GeneratorSpec<?> spec, @NotNull Class<?> targetClass, @Nullable Field field)	Processes given generator spec.

Uses of GeneratorSpec in org.instancio.internal.beanvalidation

Methods in org.instancio.internal.beanvalidation with parameters of type GeneratorSpec

Modifier and Type	Method	Description
void	BeanValidationProcessor.process(@NotNull GeneratorSpec<?> spec, @NotNull Class<?> targetClass, @Nullable Field field)
void	NoopBeanValidationProvider.process(@NotNull GeneratorSpec<?> spec, @NotNull Class<?> targetClass, @Nullable Field field)

Uses of GeneratorSpec in org.instancio.internal.generator

Classes in org.instancio.internal.generator that implement GeneratorSpec

Modifier and Type	Class	Description
class	AbstractGenerator<T>	Base class for all internal generators.

Uses of GeneratorSpec in org.instancio.internal.generator.array

Classes in org.instancio.internal.generator.array that implement GeneratorSpec

Modifier and Type	Class	Description
class	ArrayGenerator<T>
class	OneOfArrayGenerator<T>

Uses of GeneratorSpec in org.instancio.internal.generator.domain.finance

Classes in org.instancio.internal.generator.domain.finance that implement GeneratorSpec

Modifier and Type	Class	Description
class	CreditCardNumberGenerator

Uses of GeneratorSpec in org.instancio.internal.generator.domain.hash

Classes in org.instancio.internal.generator.domain.hash that implement GeneratorSpec

Modifier and Type	Class	Description
class	HashGenerator

Uses of GeneratorSpec in org.instancio.internal.generator.domain.id

Classes in org.instancio.internal.generator.domain.id that implement GeneratorSpec

Modifier and Type	Class	Description
class	EanGenerator
class	IsbnGenerator

Uses of GeneratorSpec in org.instancio.internal.generator.domain.internet

Classes in org.instancio.internal.generator.domain.internet that implement GeneratorSpec

Modifier and Type	Class	Description
class	EmailGenerator	Internal generator used for generating email addresses for fields annotated with @Email annotation from Jakarta Bean Validation API.
class	Ip4Generator

Uses of GeneratorSpec in org.instancio.internal.generator.io

Classes in org.instancio.internal.generator.io that implement GeneratorSpec

Modifier and Type	Class	Description
class	FileGenerator

Uses of GeneratorSpec in org.instancio.internal.generator.lang

Classes in org.instancio.internal.generator.lang that implement GeneratorSpec

Modifier and Type	Class	Description
class	AbstractRandomComparableNumberGeneratorSpec<T extends Number & Comparable<T>>
class	AbstractRandomNumberGeneratorSpec<T extends Number>
class	BooleanGenerator
class	ByteGenerator
class	CharacterGenerator
class	DoubleGenerator
class	EnumGenerator<E extends Enum<E>>
class	FloatGenerator
class	IntegerGenerator
class	LongGenerator
class	ShortGenerator
class	StringBuilderGenerator
class	StringGenerator

Uses of GeneratorSpec in org.instancio.internal.generator.math

Classes in org.instancio.internal.generator.math that implement GeneratorSpec

Modifier and Type	Class	Description
class	BigDecimalGenerator
class	BigIntegerGenerator

Uses of GeneratorSpec in org.instancio.internal.generator.misc

Classes in org.instancio.internal.generator.misc that implement GeneratorSpec

Modifier and Type	Class	Description
class	EmitGenerator<T>
final class	GeneratorDecorator
final class	InstantiatingGenerator
final class	SupplierAdapter

Uses of GeneratorSpec in org.instancio.internal.generator.net

Classes in org.instancio.internal.generator.net that implement GeneratorSpec

Modifier and Type	Class	Description
class	InetAddressGenerator
class	URIGenerator
class	URLGenerator

Uses of GeneratorSpec in org.instancio.internal.generator.nio.file

Classes in org.instancio.internal.generator.nio.file that implement GeneratorSpec

Modifier and Type	Class	Description
class	PathGenerator

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

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

Modifier and Type	Interface	Description
interface	InternalLengthGeneratorSpec<T>

Uses of GeneratorSpec in org.instancio.internal.generator.sql

Classes in org.instancio.internal.generator.sql that implement GeneratorSpec

Modifier and Type	Class	Description
class	SqlDateGenerator
class	TimestampGenerator

Uses of GeneratorSpec in org.instancio.internal.generator.text

Classes in org.instancio.internal.generator.text that implement GeneratorSpec

Modifier and Type	Class	Description
class	CsvGenerator
class	LoremIpsumGenerator
class	LuhnGenerator
class	TextPatternGenerator
class	UUIDStringGenerator

Methods in org.instancio.internal.generator.text with parameters of type GeneratorSpec

Modifier and Type	Method	Description
CsvGenerator	CsvGenerator.column(String name, GeneratorSpec<?> generatorSpec)

Uses of GeneratorSpec in org.instancio.internal.generator.time

Classes in org.instancio.internal.generator.time that implement GeneratorSpec

Modifier and Type	Class	Description
class	DurationGenerator
class	InstantGenerator
class	LocalDateGenerator
class	LocalDateTimeGenerator
class	LocalTimeGenerator
class	MonthDayGenerator
class	OffsetDateTimeGenerator
class	OffsetTimeGenerator
class	PeriodGenerator
class	YearGenerator
class	YearMonthGenerator
class	ZonedDateTimeGenerator
class	ZoneIdGenerator
class	ZoneOffsetGenerator

Uses of GeneratorSpec in org.instancio.internal.generator.util

Classes in org.instancio.internal.generator.util that implement GeneratorSpec

Modifier and Type	Class	Description
class	CalendarGenerator
class	CollectionGenerator<T>
class	CollectionGeneratorSpecImpl<T>
class	DateGenerator
class	EnumSetGenerator<E extends Enum<E>>
class	LocaleGenerator
class	MapEntryGenerator<K,V>
class	MapGenerator<K,V>
class	MapGeneratorSpecImpl<K,V>
class	OneOfCollectionGenerator<T>
class	OptionalGenerator<T>
class	UUIDGenerator

Uses of GeneratorSpec in org.instancio.internal.generator.util.concurrent.atomic

Classes in org.instancio.internal.generator.util.concurrent.atomic that implement GeneratorSpec

Modifier and Type	Class	Description
class	AtomicIntegerGenerator
class	AtomicLongGenerator

Uses of GeneratorSpec in org.instancio.internal.generator.xml

Classes in org.instancio.internal.generator.xml that implement GeneratorSpec

Modifier and Type	Class	Description
class	XMLGregorianCalendarGenerator

Uses of GeneratorSpec in org.instancio.internal.util

Methods in org.instancio.internal.util with parameters of type GeneratorSpec

Modifier and Type	Method	Description
static void	BeanValidationUtils.setNonNullablePrimitive(GeneratorSpec<?> spec, Field field)

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.