Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- 1. Assign to target - Search tag in org.instancio.Assign.valueOf(TargetSelector)
- Section
- 2. Assign target to another selector - Search tag in org.instancio.Assign.valueOf(TargetSelector)
- Section
- AFTER_GENERATE_HINT - Static variable in class org.instancio.settings.Keys
-
Specifies the default value of the
AfterGeneratehint supplied from custom generators to the engine; default isAfterGenerate.POPULATE_NULLS_AND_DEFAULT_PRIMITIVES; property namehint.after.generate. - afterGenerate() - Method in class org.instancio.generator.Hints
-
Returns the after generate action to be performed by the engine.
- afterGenerate(AfterGenerate) - Static method in class org.instancio.generator.Hints
-
Returns an instance of hints containing the specified
AfterGeneratevalue. - afterGenerate(AfterGenerate) - Method in class org.instancio.generator.Hints.Builder
-
A hint indicating what should be done with the object created by the generator.
- AfterGenerate - Enum in org.instancio.generator
-
A hint that specifies an action to be taken after an object is generated by a generator.
- all() - Static method in class org.instancio.settings.Keys
-
Returns all keys supported by Instancio.
- all(Class<?>) - Static method in class org.instancio.Select
-
Select all instances of the given type, not including subtypes.
- all(GroupableSelector...) - Static method in class org.instancio.Select
-
A convenience method for combining multiple selectors.
- allBooleans() - Static method in class org.instancio.Select
-
Selects all booleans, primitive and wrapper.
- allBytes() - Static method in class org.instancio.Select
-
Selects all bytes, primitive and wrapper.
- allChars() - Static method in class org.instancio.Select
-
Selects all characters, primitive and wrapper.
- allDoubles() - Static method in class org.instancio.Select
-
Selects all doubles, primitive and wrapper.
- allFloats() - Static method in class org.instancio.Select
-
Selects all floats, primitive and wrapper.
- allInts() - Static method in class org.instancio.Select
-
Selects all integers, primitive and wrapper.
- allLongs() - Static method in class org.instancio.Select
-
Selects all longs, primitive and wrapper.
- allowEmpty() - Method in interface org.instancio.generator.specs.OptionalGeneratorSpec
-
Specifies that an empty
Optionalcan be generated. - allowEmpty() - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Indicates that an empty string can be generated.
- allowEmpty() - Method in interface org.instancio.generator.specs.StringSpec
- allowEmpty() - Method in interface org.instancio.generator.specs.TextPatternGeneratorSpec
-
Indicates that an empty string can be generated.
- allowEmpty() - Method in interface org.instancio.generator.specs.TextPatternSpec
-
Indicates that an empty string can be generated.
- allowEmpty(boolean) - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Indicates if empty string can be generated.
- allowEmpty(boolean) - Method in interface org.instancio.generator.specs.StringSpec
- Allow null values to be generated - Search tag in class org.instancio.Instancio
- Section
- allowsNullValue() - Method in interface org.instancio.settings.SettingKey
-
Indicates whether the value for this key can be set to
null. - allowZero() - Method in interface org.instancio.generator.specs.DurationGeneratorSpec
-
Allow a
Durationof length zero to be generated. - allowZero() - Method in interface org.instancio.generator.specs.DurationSpec
- allShorts() - Static method in class org.instancio.Select
-
Selects all shorts, primitive and wrapper.
- allStrings() - Static method in class org.instancio.Select
-
Shorthand for
all(String.class). - ALPHABETIC - Enum constant in enum org.instancio.settings.StringType
-
Represents an alphabetic string, uppercase by default, that consists of characters
[A-Z]. - alphanumeric(int) - Method in interface org.instancio.Random
-
Generates a random alphanumeric String comprised of
[a-z, A-Z, 0-9]. - alphaNumeric() - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Generates an alphanumeric string, uppercase by default, that consists of characters
[0-9A-Z]. - alphaNumeric() - Method in interface org.instancio.generator.specs.StringSpec
- ALPHANUMERIC - Enum constant in enum org.instancio.settings.StringType
-
Represents an alphanumeric string, uppercase by default, that consists of characters
[0-9A-Z]. - alphanumericCharacter() - Method in interface org.instancio.Random
-
Returns a random alphanumeric character,
[a-z, A-Z, 0-9]. - annotated(Class<? extends A>) - Method in interface org.instancio.FieldSelectorBuilder
-
Matches fields annotated with the specified annotation, ignoring inherited annotations.
- annotated(Class<? extends A>) - Method in interface org.instancio.TypeSelectorBuilder
-
Matches types annotated with the specified annotation, ignoring inherited annotations.
- apply(T, Random) - Method in interface org.instancio.RandomFunction
-
Applies this function to the given
input. - apply(T, Random) - Method in interface org.instancio.RandomUnaryOperator
-
Applies this operator to the given operand, using the provided
Randominstance. - APPLY_SELECTORS - Enum constant in enum org.instancio.generator.AfterGenerate
-
Indicates that an object created by the generator can be modified using any of the following methods:
InstancioApi.set(TargetSelector, Object)InstancioApi.supply(TargetSelector, Generator)InstancioApi.generate(TargetSelector, GeneratorSpecProvider) - applyFeed(TargetSelector, Feed) - Method in interface org.instancio.BaseApi
-
Applies the provided
feedto the specifiedselector. - applyFeed(TargetSelector, Feed) - Method in interface org.instancio.InstancioApi
-
Applies the provided
feedto the specifiedselector. - applyFeed(TargetSelector, Feed) - Method in interface org.instancio.InstancioCartesianProductApi
-
Applies the provided
feedto the specifiedselector. - applyFeed(TargetSelector, FeedProvider) - Method in interface org.instancio.BaseApi
-
Creates a feed and applies it to the specified
selector. - applyFeed(TargetSelector, FeedProvider) - Method in interface org.instancio.InstancioApi
-
Creates a feed and applies it to the specified
selector. - applyFeed(TargetSelector, FeedProvider) - Method in interface org.instancio.InstancioCartesianProductApi
-
Creates a feed and applies it to the specified
selector. - array() - Method in interface org.instancio.generators.Generators
-
Generator for arrays.
- ARRAY_ELEMENTS_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a
nullcan be generated for array elements; default isfalse; property namearray.elements.nullable. - ARRAY_MAX_LENGTH - Static variable in class org.instancio.settings.Keys
-
Specifies maximum length for arrays; default is 6; property name
array.max.length. - ARRAY_MIN_LENGTH - Static variable in class org.instancio.settings.Keys
-
Specifies minimum length for arrays; default is 2; property name
array.min.length. - ARRAY_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a null can be generated for arrays; default is
false; property namearray.nullable. - ArrayGeneratorSpec<T> - Interface in org.instancio.generator.specs
-
Generator spec for arrays.
- ArrayHint - Class in org.instancio.generator.hints
-
This hint is for generators that create arrays.
- ArrayHint.Builder - Class in org.instancio.generator.hints
-
Builder class for this hint.
- as(Function<T, R>) - Method in interface org.instancio.generator.specs.AsGeneratorSpec
-
Converts the generated value to another type using the specified mapping function.
- as(Function<T, R>) - Method in interface org.instancio.InstancioApi
-
A convenience method for mapping the result (as returned by the
InstancioApi.create()method) to another object using afunction. - as(Function<T, R>) - Method in interface org.instancio.ValueOfOriginDestination
-
Specifies a function for mapping the value of the origin selector to another value.
- as(RandomFunction<T, R>) - Method in interface org.instancio.ValueOfOriginDestination
-
Specifies a function for mapping the value of the origin selector to another (randomised) value.
- AsGeneratorSpec<T> - Interface in org.instancio.generator.specs
-
Allows mapping the result of a generator to another type.
- asResult() - Method in interface org.instancio.InstancioApi
-
Returns a
Resultcontaining the created object and seed value used to generate its values. - assign(Assignment...) - Method in interface org.instancio.BaseApi
-
Generates values based on given assignments.
- assign(Assignment...) - Method in interface org.instancio.InstancioApi
-
Generates values based on given assignments.
- assign(Assignment...) - Method in interface org.instancio.InstancioCartesianProductApi
-
Generates values based on given assignments.
- Assign - Class in org.instancio
-
A collection of static factory methods for creating assignments.
- ASSIGN_FIELD - Enum constant in enum org.instancio.settings.OnSetMethodError
-
Use field assignment as the fallback (default behaviour).
- ASSIGN_FIELD - Enum constant in enum org.instancio.settings.OnSetMethodNotFound
-
Use field assignment as the fallback (default behaviour).
- Assignment - Interface in org.instancio
-
An assignment that can be passed to the
InstancioApi.assign(Assignment...)method. - ASSIGNMENT_TYPE - Static variable in class org.instancio.settings.Keys
-
Specifies whether to assign values using fields or methods; default is
AssignmentType.FIELD; property nameassignment.type. - AssignmentType - Enum in org.instancio.settings
-
A setting that specifies whether objects should be populated via fields or methods.
- asString() - Method in interface org.instancio.generator.specs.AsGeneratorSpec
-
Converts the generated value to a
String. - atDepth(int) - Method in interface org.instancio.DepthSelector
-
Restricts this selector's targets to the specified depth.
- atDepth(int) - Method in interface org.instancio.FieldSelectorBuilder
-
Restricts this selector's targets to the specified depth.
- atDepth(int) - Method in interface org.instancio.PredicateSelector
-
Restricts this selector's targets to the specified depth.
- atDepth(int) - Method in interface org.instancio.Selector
-
Restricts this selector's targets to the specified depth.
- atDepth(int) - Method in interface org.instancio.TypeSelectorBuilder
-
Restricts this selector's targets to the specified depth.
- atDepth(Predicate<Integer>) - Method in interface org.instancio.DepthPredicateSelector
-
Restricts this selector's targets to a depth that satisfies the given
predicate. - atDepth(Predicate<Integer>) - Method in interface org.instancio.FieldSelectorBuilder
-
Restricts this selector's targets to a depth that satisfies the given
predicate. - atDepth(Predicate<Integer>) - Method in interface org.instancio.PredicateSelector
-
Restricts this selector's targets to a depth that satisfies the given
predicate. - atDepth(Predicate<Integer>) - Method in interface org.instancio.TypeSelectorBuilder
-
Restricts this selector's targets to a depth that satisfies the given
predicate. - atomic() - Method in interface org.instancio.generators.Generators
-
Provides access to atomic generators.
- AtomicGenerators - Interface in org.instancio.generators
-
Contains built-in generators for
java.util.concurrent.atomicclasses. - atomicInteger() - Method in interface org.instancio.generators.AtomicGenerators
-
Customises generated
AtomicIntegervalues. - atomicLong() - Method in interface org.instancio.generators.AtomicGenerators
-
Customises generated
AtomicLongvalues.
B
- BaseApi<T> - Interface in org.instancio
-
Defines top-level operations supported by the API.
- BEAN_VALIDATION_ENABLED - Static variable in class org.instancio.settings.Keys
-
Specifies whether values should be generated based on Jakarta Bean Validation 3.0 annotations, if present; default is
false; property namebean.validation.api.enabled. - BEAN_VALIDATION_TARGET - Static variable in class org.instancio.settings.Keys
-
Specifies whether Bean Validation annotations are declared on fields or getters; default is
BeanValidationTarget.FIELD; property namebean.validation.target. - BeanValidationTarget - Enum in org.instancio.settings
-
A setting that specifies whether Bean Validation annotations are declared on fields or getters.
- BIG_DECIMAL_SCALE - Static variable in class org.instancio.settings.Keys
-
Specifies the
scalefor generatingBigDecimal; default is2; property namebigdecimal.scale. - bigDecimal() - Method in interface org.instancio.generators.MathGenerators
-
Customises generated
BigDecimalvalues. - bigDecimal() - Method in interface org.instancio.generators.MathSpecs
-
Customises generated
BigDecimalvalues. - BigDecimalGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for
BigDecimal. - bigDecimalSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
BigDecimalspec for the given property name. - BigDecimalSpec - Interface in org.instancio.generator.specs
-
Spec for generating
BigDecimalvalues. - bigInteger() - Method in interface org.instancio.generators.MathGenerators
-
Customises generated
BigIntegervalues. - bigInteger() - Method in interface org.instancio.generators.MathSpecs
-
Customises generated
BigIntegervalues. - bigIntegerSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
BigIntegerspec for the given property name. - BigIntegerSpec - Interface in org.instancio.generator.specs
-
Spec for generating
BigIntegervalues. - birthdate(Generator<LocalDate>) - Method in interface org.instancio.generator.specs.pol.PeselGeneratorSpec
-
Specifies a generator for the birthdate.
- birthdate(Generator<LocalDate>) - Method in interface org.instancio.generator.specs.pol.PeselSpec
-
Specifies a generator for the birthdate.
- BOOLEAN_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a
nullcan be generated for Boolean type; default isfalse; property nameboolean.nullable. - BooleanGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for booleans.
- booleans() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Generator for
Booleanvalues. - booleans() - Method in interface org.instancio.generators.Generators
-
Generator for
Booleanvalues. - booleans() - Method in interface org.instancio.generators.ValueSpecs
-
Generator for
Booleanvalues. - booleanSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
Booleanspec for the given property name. - BooleanSpec - Interface in org.instancio.generator.specs
-
Spec for generating
Booleanvalues. - bra() - Method in interface org.instancio.generators.IdGenerators
-
Provides access to identifier generators for Brazil.
- bra() - Method in interface org.instancio.generators.IdSpecs
-
Provides access to identifier generators for Brazil.
- BraIdGenerators - Interface in org.instancio.generators.bra
-
Contains built-in generators for Brazilian identifiers.
- BraIdSpecs - Interface in org.instancio.generators.bra
-
Provides generators for Brazilian identifiers.
- build() - Method in class org.instancio.generator.hints.ArrayHint.Builder
-
Builds the object.
- build() - Method in class org.instancio.generator.Hints.Builder
-
Builds the object.
- build() - Method in class org.instancio.generator.hints.CollectionHint.Builder
-
Builds the object.
- build() - Method in class org.instancio.generator.hints.MapHint.Builder
-
Builds the object.
- builder() - Static method in class org.instancio.generator.hints.ArrayHint
-
Returns a builder for this hint type.
- builder() - Static method in class org.instancio.generator.Hints
-
Returns an instance of the builder.
- builder() - Static method in class org.instancio.generator.hints.CollectionHint
-
Returns a builder for this hint type.
- builder() - Static method in class org.instancio.generator.hints.MapHint
-
Returns a builder for this hint type.
- builder(Hints) - Static method in class org.instancio.generator.Hints
- BYTE_MAX - Static variable in class org.instancio.settings.Keys
-
Specifies maximum value for bytes; default is 127; property name
byte.max. - BYTE_MIN - Static variable in class org.instancio.settings.Keys
-
Specifies minimum value for bytes; default is 1; property name
byte.min. - BYTE_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a
nullcan be generated for Byte type; default isfalse; property namebyte.nullable. - byteRange(byte, byte) - Method in interface org.instancio.Random
-
Returns a random
bytewithin the given range. - bytes() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Generator for
Bytevalues. - bytes() - Method in interface org.instancio.generators.Generators
-
Generator for
Bytevalues. - bytes() - Method in interface org.instancio.generators.ValueSpecs
-
Generator for
Bytevalues. - byteSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
Bytespec for the given property name. - ByteSpec - Interface in org.instancio.generator.specs
-
Spec for generating
Bytevalues.
C
- calendar() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises generated
Calendarvalues. - calendar() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises generated
Calendarvalues. - can() - Method in interface org.instancio.generators.IdGenerators
-
Provides access to identifier generators for Canada.
- can() - Method in interface org.instancio.generators.IdSpecs
-
Provides access to identifier generators for Canada.
- CanIdGenerators - Interface in org.instancio.generators.can
-
Contains built-in generators for Canadian identifiers.
- CanIdSpecs - Interface in org.instancio.generators.can
-
Provides generators for Canadian identifiers.
- character() - Method in interface org.instancio.Random
-
Returns a random alphabetic character,
[a-z, A-Z]. - CHARACTER_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a
nullcan be generated for Character type; default isfalse; property namecharacter.nullable. - CharacterGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for characters.
- characterRange(char, char) - Method in interface org.instancio.Random
-
Returns a random
charwithin the given range. - characterSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
Characterspec for the given property name. - CharacterSpec - Interface in org.instancio.generator.specs
-
Spec for generating
Charactervalues. - chars() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Generator for
Charactervalues. - chars() - Method in interface org.instancio.generators.Generators
-
Generator for
Charactervalues. - chars() - Method in interface org.instancio.generators.ValueSpecs
-
Generator for
Charactervalues. - checkDigitIndex(int) - Method in interface org.instancio.generator.specs.LuhnGeneratorSpec
-
The index of the check digit in the input.
- checkDigitIndex(int) - Method in interface org.instancio.generator.specs.LuhnSpec
- checkDigitIndex(int) - Method in interface org.instancio.generator.specs.Mod10GeneratorSpec
-
The index of the check digit in the input.
- checkDigitIndex(int) - Method in interface org.instancio.generator.specs.Mod10Spec
- checkDigitIndex(int) - Method in interface org.instancio.generator.specs.Mod11GeneratorSpec
-
The index of the check digit in the input.
- checkDigitIndex(int) - Method in interface org.instancio.generator.specs.Mod11Spec
-
The index of the check digit in the input.
- checksum() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Provides access to checksum generators.
- checksum() - Method in interface org.instancio.generators.Generators
-
Provides access to checksum generators.
- checksum() - Method in interface org.instancio.generators.ValueSpecs
-
Provides access to checksum generators.
- ChecksumGenerators - Interface in org.instancio.generators
-
Contains built-in generators for checksum-valid numbers.
- ChecksumSpecs - Interface in org.instancio.generators
-
Provides generators for checksum-valid numbers.
- cnpj() - Method in interface org.instancio.generators.bra.BraIdGenerators
-
Generates Cadastro Nacional de Pessoas JurÃdicas (CNPJ).
- cnpj() - Method in interface org.instancio.generators.bra.BraIdSpecs
-
Generates Cadastro Nacional de Pessoas JurÃdicas (CNPJ).
- CnpjGeneratorSpec - Interface in org.instancio.generator.specs.bra
-
Spec for generating Brazilian 'Cadastro Nacional de Pessoas JurÃdicas' (CNPJ).
- CnpjSpec - Interface in org.instancio.generator.specs.bra
-
Spec for generating Brazilian 'Cadastro Nacional de Pessoas JurÃdicas' (CNPJ).
- collection() - Method in interface org.instancio.generators.Generators
-
Generator for collections.
- COLLECTION_ELEMENTS_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a
nullcan be generated for collection elements; default isfalse; property namecollection.elements.nullable. - COLLECTION_MAX_SIZE - Static variable in class org.instancio.settings.Keys
-
Specifies maximum size for collections; default is 6; property name
collection.max.size. - COLLECTION_MIN_SIZE - Static variable in class org.instancio.settings.Keys
-
Specifies minimum size for collections; default is 2; property name
collection.min.size. - COLLECTION_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a
nullcan be generated for collections; default isfalse; property namecollection.nullable. - CollectionGeneratorSpec<T> - Interface in org.instancio.generator.specs
-
Generator spec for collections.
- CollectionHint - Class in org.instancio.generator.hints
-
This hint is for generators that create collections.
- CollectionHint.Builder - Class in org.instancio.generator.hints
-
Builder class for this hint.
- column(String, Generator<?>) - Method in interface org.instancio.generator.specs.CsvGeneratorSpec
-
Specifies the column name and the generator for producing the values.
- column(String, Generator<?>) - Method in interface org.instancio.generator.specs.CsvSpec
-
Specifies the column name and the generator for producing the values.
- column(String, GeneratorSpec<?>) - Method in interface org.instancio.generator.specs.CsvGeneratorSpec
-
Specifies the column name and the generator spec for producing the values.
- column(String, GeneratorSpec<?>) - Method in interface org.instancio.generator.specs.CsvSpec
-
Specifies the column name and the generator spec for producing the values.
- commentPrefix(String) - Method in interface org.instancio.feed.FormatOptionsProvider.FormatOptions.CsvFormatOptions
-
Sets the comment prefix (lines starting with this prefix will be treated as comments); default value is
"#". - CommonGeneratorSpecs - Interface in org.instancio.generators
-
Defines specs that are available via both:
InstancioApi.generate(TargetSelector, GeneratorSpecProvider)Instancio.gen() - ConvertibleToScope - Interface in org.instancio
-
An interface for selectors that can be converted to a
Scope. - coordinate() - Method in interface org.instancio.generators.SpatialGenerators
-
Customises generated latitudinal and longitudinal values.
- coordinate() - Method in interface org.instancio.generators.SpatialSpecs
-
Customises generated latitudinal and longitudinal values.
- CoordinateGeneratorSpec - Interface in org.instancio.generator.specs
-
Spec for generating coordinate values.
- CoordinateSpec - Interface in org.instancio.generator.specs
-
Spec for generating spatial coordinate values.
- cpf() - Method in interface org.instancio.generators.bra.BraIdGenerators
-
Generates Cadastro de Pessoa Fisica (CPF).
- cpf() - Method in interface org.instancio.generators.bra.BraIdSpecs
-
Generates Cadastro de Pessoa Fisica (CPF).
- CpfGeneratorSpec - Interface in org.instancio.generator.specs.bra
-
Spec for generating Brazilian 'Cadastro de Pessoas FÃsicas' (CPF).
- CpfSpec - Interface in org.instancio.generator.specs.bra
-
Spec for generating Brazilian 'Cadastro de Pessoas FÃsicas' (CPF).
- create() - Method in interface org.instancio.InstancioApi
-
Creates a new instance of a class and populates it with data.
- create() - Method in interface org.instancio.InstancioCartesianProductApi
-
Returns he Cartesian product generated from values specified via the
InstancioCartesianProductApi.with(TargetSelector, Object[])method as a list. - create() - Method in interface org.instancio.InstancioFeedApi
-
Creates an instance of the feed.
- create() - Method in interface org.instancio.settings.SettingKey.SettingKeyBuilder
-
Returns the created setting key.
- create() - Static method in interface org.instancio.settings.Settings
-
Creates a new instance of empty settings.
- create(Class<T>) - Static method in class org.instancio.Instancio
-
Creates an instance of the specified class.
- create(Model<T>) - Static method in class org.instancio.Instancio
-
Creates an object populated using the given model.
- create(TypeTokenSupplier<T>) - Static method in class org.instancio.Instancio
-
Creates an object of type specified by the type token.
- Create and populate an instance of a class - Search tag in class org.instancio.Instancio
- Section
- createBlank(Class<T>) - Static method in class org.instancio.Instancio
-
Creates a blank object of the specified class.
- createDirectory() - Method in interface org.instancio.generator.specs.FilePathSpec
- createDirectory() - Method in interface org.instancio.generator.specs.FileSpec
- createDirectory() - Method in interface org.instancio.generator.specs.PathGeneratorSpec
-
Terminal method to indicate that the generated path, including parent directories (if any), should be created as a directory in the file system.
- createDirectory() - Method in interface org.instancio.generator.specs.PathSpec
- createFeed(Class<F>) - Static method in class org.instancio.Instancio
-
Creates a feed of the specified type.
- createFile() - Method in interface org.instancio.generator.specs.FilePathSpec
- createFile() - Method in interface org.instancio.generator.specs.FileSpec
- createFile() - Method in interface org.instancio.generator.specs.PathGeneratorSpec
-
Terminal method to indicate that the generated path, including parent directories (if any), should be created as a file in the file system.
- createFile() - Method in interface org.instancio.generator.specs.PathSpec
- createFile(InputStream) - Method in interface org.instancio.generator.specs.FilePathSpec
- createFile(InputStream) - Method in interface org.instancio.generator.specs.FileSpec
- createFile(InputStream) - Method in interface org.instancio.generator.specs.PathGeneratorSpec
-
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.
- createFile(InputStream) - Method in interface org.instancio.generator.specs.PathSpec
- createList(Class<T>) - Static method in class org.instancio.Instancio
-
Creates a
Listof random size. - createMap(Class<K>, Class<V>) - Static method in class org.instancio.Instancio
-
Creates a
Mapof random size. - createSet(Class<T>) - Static method in class org.instancio.Instancio
-
Creates a
Setof random size. - Creating generic classes - Search tag in class org.instancio.Instancio
- Section
- Creating instances of a class from a Model - Search tag in class org.instancio.Instancio
- Section
- creditCard() - Method in interface org.instancio.generators.FinanceGenerators
-
Generates credit card numbers.
- creditCard() - Method in interface org.instancio.generators.FinanceSpecs
-
Generates credit card numbers.
- CreditCardGeneratorSpec - Interface in org.instancio.generator.specs
-
Spec for generating credit card numbers.
- CreditCardSpec - Interface in org.instancio.generator.specs
-
Spec for generating credit card numbers.
- csv() - Method in interface org.instancio.feed.FormatOptionsProvider.FormatOptionsFactory
-
Allows specifying configuration options for parsing CSV files.
- csv() - Method in interface org.instancio.generators.TextGenerators
-
Generates CSV.
- csv() - Method in interface org.instancio.generators.TextSpecs
-
Generates CSV.
- CSV - Enum constant in enum org.instancio.settings.FeedFormatType
-
CSV format.
- CsvGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for producing CSV.
- CsvSpec - Interface in org.instancio.generator.specs
-
Spec for generating CSV.
- Customise object's values - Search tag in class org.instancio.Instancio
- Section
D
- dataAccess(FeedDataAccess) - Method in interface org.instancio.FeedApi
-
Specifies the data access mode for the feed (sequential or random).
- dataAccess(FeedDataAccess) - Method in interface org.instancio.InstancioFeedApi
-
Specifies the data access mode for the feed (sequential or random).
- DataSource - Interface in org.instancio.feed
-
A data source for specs defined by a
Feed. - DataSourceProvider - Interface in org.instancio.feed
-
Provides a
DataSourceusing the specifiedDataSourceProvider.DataSourceFactory. - DataSourceProvider.DataSourceFactory - Interface in org.instancio.feed
-
Creates
DataSourceobjects from various underlying sources. - date() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises generated
Datevalues. - date() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises generated
Datevalues. - days(int, int) - Method in interface org.instancio.generator.specs.PeriodGeneratorSpec
-
Generate number of
Perioddays in the given range. - days(int, int) - Method in interface org.instancio.generator.specs.PeriodSpec
-
Generate number of
Perioddays in the given range. - declaredIn(Class<?>) - Method in interface org.instancio.FieldSelectorBuilder
-
Matches fields declared in the specified class.
- DEFAULT_PARAGRAPHS - Static variable in interface org.instancio.generator.specs.LoremIpsumGeneratorSpec
-
Default number of paragraphs.
- DEFAULT_WORDS - Static variable in interface org.instancio.generator.specs.LoremIpsumGeneratorSpec
-
Default number of words.
- defaults() - Static method in interface org.instancio.settings.Settings
-
Creates a new instance containing default settings.
- defaultValue() - Method in interface org.instancio.settings.SettingKey
-
Default value for this key.
- delimiter(char) - Method in interface org.instancio.feed.FormatOptionsProvider.FormatOptions.CsvFormatOptions
-
Sets the delimiter character; default value is
','. - delimiter(String) - Method in interface org.instancio.generator.specs.CsvGeneratorSpec
-
Specifies the delimiter used to separate values.
- delimiter(String) - Method in interface org.instancio.generator.specs.CsvSpec
-
Specifies the delimiter used to separate values.
- DepthPredicateSelector - Interface in org.instancio
-
Interface for specifying the depth of a selector's target using a predicate.
- DepthSelector - Interface in org.instancio
-
Interface for specifying the depth of a selector's target.
- diceRoll(boolean) - Method in interface org.instancio.Random
-
Returns
truewith a1/6probability, but only if thepreconditionis true. - digits() - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Generates a string that consists of digits
[0-9]. - digits() - Method in interface org.instancio.generator.specs.StringSpec
- digits(int) - Method in interface org.instancio.Random
-
Generates a random String comprised of digits
[0-9]. - DIGITS - Enum constant in enum org.instancio.settings.StringType
-
Represents a string that consists of digits
[0-9]. - DO_NOT_MODIFY - Enum constant in enum org.instancio.generator.AfterGenerate
-
Indicates that an object created by the generator should not be modified.
- DOUBLE_MAX - Static variable in class org.instancio.settings.Keys
-
Specifies maximum value for doubles; default is 10000; property name
double.max. - DOUBLE_MIN - Static variable in class org.instancio.settings.Keys
-
Specifies minimum value for doubles; default is 1; property name
double.min. - DOUBLE_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a
nullcan be generated for Double type; default isfalse; property namedouble.nullable. - doubleRange(double, double) - Method in interface org.instancio.Random
-
Returns a random
doublewithin the given range. - doubles() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Generator for
Doublevalues. - doubles() - Method in interface org.instancio.generators.Generators
-
Generator for
Doublevalues. - doubles() - Method in interface org.instancio.generators.ValueSpecs
-
Generator for
Doublevalues. - doubleSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
Doublespec for the given property name. - DoubleSpec - Interface in org.instancio.generator.specs
-
Spec for generating
Doublevalues. - duration() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises returned
Durationvalue. - duration() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises returned
Durationvalue. - DurationGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for
Duration. - DurationSpec - Interface in org.instancio.generator.specs
-
Spec for generating
Duration.
E
- ean() - Method in interface org.instancio.generators.IdGenerators
-
Generates European Article Number (EAN).
- ean() - Method in interface org.instancio.generators.IdSpecs
-
Generates European Article Number (EAN).
- EanGeneratorSpec - Interface in org.instancio.generator.specs
-
Spec for generating European Article Number (EAN).
- EanSpec - Interface in org.instancio.generator.specs
-
Spec for generating European Article Number (EAN).
- elseGenerate(GeneratorSpec<T>) - Method in interface org.instancio.GivenOriginDestinationAction
-
Generates values using arbitrary generator specs.
- elseGenerate(GeneratorSpecProvider<T>) - Method in interface org.instancio.GivenOriginDestinationAction
-
Generates values using built-in generators provided by the
genparameter, of typeGenerators. - elseSet(T) - Method in interface org.instancio.GivenOriginDestinationAction
-
Sets a value to matching selector targets.
- elseSupply(Supplier<T>) - Method in interface org.instancio.GivenOriginDestinationAction
-
Supplies an object using a
Supplier. - elseSupply(Generator<T>) - Method in interface org.instancio.GivenOriginDestinationAction
-
Supplies an object using a
Generatorto matching selector targets. - email() - Method in interface org.instancio.generators.NetGenerators
-
Customises generated email addresses.
- email() - Method in interface org.instancio.generators.NetSpecs
-
Customises generated email addresses.
- EmailGeneratorSpec - Interface in org.instancio.generator.specs
-
Spec for generating email addresses.
- EmailSpec - Interface in org.instancio.generator.specs
-
Spec for generating email addresses.
- emit() - Method in interface org.instancio.generators.Generators
-
Emits provided items to a selector's target.
- EmitGeneratorSpec<T> - Interface in org.instancio.generator.specs
-
A generator spec that emits given items to a selector's target.
- empty() - Static method in class org.instancio.generator.hints.ArrayHint
-
Returns an empty hint containing default values.
- empty() - Static method in class org.instancio.generator.hints.CollectionHint
-
Returns an empty hint containing default values.
- empty() - Static method in class org.instancio.generator.hints.MapHint
-
Returns an empty hint containing default values.
- end() - Method in interface org.instancio.IntervalSupplier
-
Returns a supplier that produces interval end value.
- endIndex(int) - Method in interface org.instancio.generator.specs.LuhnGeneratorSpec
-
The end index for calculating the checksum.
- endIndex(int) - Method in interface org.instancio.generator.specs.LuhnSpec
- endIndex(int) - Method in interface org.instancio.generator.specs.Mod10GeneratorSpec
-
The end index for calculating the checksum.
- endIndex(int) - Method in interface org.instancio.generator.specs.Mod10Spec
- endIndex(int) - Method in interface org.instancio.generator.specs.Mod11GeneratorSpec
-
The end index for calculating the checksum.
- endIndex(int) - Method in interface org.instancio.generator.specs.Mod11Spec
-
The end index for calculating the checksum.
- EnumGeneratorSpec<E> - Interface in org.instancio.generator.specs
-
Generator spec for
Enums. - enumOf(Class<E>) - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Generator for enum values.
- enumOf(Class<E>) - Method in interface org.instancio.generators.Generators
-
Generator for enum values.
- enumOf(Class<E>) - Method in interface org.instancio.generators.ValueSpecs
-
Generator for enum values.
- enumSet(Class<E>) - Method in interface org.instancio.generators.Generators
-
Generator for
EnumSet. - EnumSetGeneratorSpec<E> - Interface in org.instancio.generator.specs
-
Generator spec for
EnumSet. - EnumSpec<E> - Interface in org.instancio.generator.specs
-
Spec for generating enums.
- excluding(E...) - Method in interface org.instancio.generator.specs.EnumGeneratorSpec
-
Generate an enum while excluding the specified values.
- excluding(E...) - Method in interface org.instancio.generator.specs.EnumSetGeneratorSpec
-
Specifies enum values to exclude from the generated
EnumSet. - excluding(E...) - Method in interface org.instancio.generator.specs.EnumSpec
-
Generate an enum while excluding the specified values.
- excluding(Class<?>) - Method in interface org.instancio.TypeSelectorBuilder
-
Excludes specified class from matching.
- ExperimentalApi - Annotation Type in org.instancio.documentation
-
Denotes experimental APIs that may be modified or removed entirely at any time, even across minor versions.
F
- FAIL - Enum constant in enum org.instancio.settings.FeedDataEndAction
-
Throws an exception when end of data is reached.
- FAIL - Enum constant in enum org.instancio.settings.OnSetFieldError
-
Propagate the error up by throwing
InstancioApiException. - FAIL - Enum constant in enum org.instancio.settings.OnSetMethodError
-
Propagate the error up by throwing
InstancioApiException. - FAIL - Enum constant in enum org.instancio.settings.OnSetMethodNotFound
-
Fail by throwing
InstancioApiException. - FAIL_ON_ERROR - Static variable in class org.instancio.settings.Keys
-
Specifies whether internal exceptions should be propagated up; default is
false; property namefail.on.error. - Feed - Interface in org.instancio.feed
-
This interface provides support for using data from external sources (such as CSV or JSON files) and enables the following use cases: Generating values using methods defined by a feed. Populating values via the
generate()method. Mapping feed data to an object usingapplyFeed(). Using a feed instance as a parameterized test argument. - FEED_DATA_ACCESS - Static variable in class org.instancio.settings.Keys
-
Specifies whether
Feeddata is retrieved sequentially or randomly; default isFeedDataAccess.SEQUENTIAL; property namefeed.data.access. - FEED_DATA_END_ACTION - Static variable in class org.instancio.settings.Keys
-
Specifies the behaviour when
Feedend of data has been reached (only applicable ifKeys.FEED_DATA_ACCESSis set toFeedDataAccess.SEQUENTIAL); default isFeedDataEndAction.FAIL; property namefeed.data.end.action. - FEED_DATA_TRIM - Static variable in class org.instancio.settings.Keys
-
Specifies the trimming mode for feed data; default is
FeedDataTrim.UNQUOTED; property namefeed.data.trim. - FEED_FORMAT_TYPE - Static variable in class org.instancio.settings.Keys
-
Specifies the feed format type; default is
FeedFormatType.CSV; property namefeed.format.type. - FEED_TAG_KEY - Static variable in class org.instancio.settings.Keys
- FEED_TAG_VALUE - Static variable in class org.instancio.settings.Keys
-
Specifies the default tag value for a
Feed; default isnull(includes all tags); property namefeed.tag.value. - Feed.DataAccess - Annotation Type in org.instancio.feed
-
Specifies the data access strategy to be used by a feed.
- Feed.FormatType - Annotation Type in org.instancio.feed
-
Annotation for specifying the data format type for a feed.
- Feed.Source - Annotation Type in org.instancio.feed
-
An annotation for specifying data for a
Feed. - Feed.TagKey - Annotation Type in org.instancio.feed
-
Annotation for specifying a property to use as a tag key in a data feed.
- FeedApi - Interface in org.instancio
-
Interface for configuring
Feedinstances. - FeedDataAccess - Enum in org.instancio.settings
-
Specifies how
Feeddata is accessed. - FeedDataEndAction - Enum in org.instancio.settings
-
This setting is only applicable if
Keys.FEED_DATA_ACCESSis set toFeedDataAccess.SEQUENTIAL. - FeedDataTrim - Enum in org.instancio.settings
-
Enumeration representing the options for trimming data in a feed.
- FeedFormatType - Enum in org.instancio.settings
-
Enumeration of data format types supported by the
Feed.Sourceannotation. - FeedProvider - Interface in org.instancio.feed
-
Provider interface for building
Feedinstances. - FeedProvider.FeedBuilderFactory - Interface in org.instancio.feed
-
Factory for building instances of a
Feed. - FeedSpec<T> - Interface in org.instancio.feed
-
The return type for spec methods declared by a
Feed. - FeedSpecAccessors - Interface in org.instancio.feed
-
Defines built-in accessors for a
Feed. - FeedSpecAnnotations - Interface in org.instancio.feed
-
Defines annotations that can be used with
FeedSpecmethods. - FeedSpecAnnotations.DataSpec - Annotation Type in org.instancio.feed
-
Allows mapping a property name from an external data source to a spec method in a
Feed. - FeedSpecAnnotations.FunctionSpec - Annotation Type in org.instancio.feed
-
A spec that is derived from one or more other specs.
- FeedSpecAnnotations.GeneratedSpec - Annotation Type in org.instancio.feed
-
A feed spec that is generated by a
Generator. - FeedSpecAnnotations.NullableSpec - Annotation Type in org.instancio.feed
-
Specifies that the annotated spec method can generate
nullvalues. - FeedSpecAnnotations.TemplateSpec - Annotation Type in org.instancio.feed
-
A template spec is for producing string values based on a string template with inputs provided by other specs.
- FeedSpecAnnotations.WithPostProcessor - Annotation Type in org.instancio.feed
-
This annotation allows specifying one or more
PostProcessorclasses for processing values returned by the annotated spec method. - FeedSpecAnnotations.WithStringMapper - Annotation Type in org.instancio.feed
-
Annotation to specify a custom
Functionto be used for converting string values to a specified type. - female() - Method in interface org.instancio.generator.specs.pol.PeselGeneratorSpec
-
Specifies that female PESEL should be generated.
- female() - Method in interface org.instancio.generator.specs.pol.PeselSpec
-
Specifies that female PESEL should be generated.
- field(Class<?>, String) - Static method in class org.instancio.Select
-
Selects a field by name in the specified class.
- field(String) - Static method in class org.instancio.Select
-
Selects a field by name declared in the class being created.
- field(GetMethodSelector<T, R>) - Static method in class org.instancio.Select
-
Selects a field based on the given method reference.
- FIELD - Enum constant in enum org.instancio.settings.AssignmentType
-
Indicates that values should be assigned directly to fields, bypassing setters (default behaviour).
- FIELD - Enum constant in enum org.instancio.settings.BeanValidationTarget
-
Indicates that constraints are specified on fields (default value).
- fields() - Static method in class org.instancio.Select
-
Provides a builder for selecting fields based on
Predicates. - fields(Predicate<Field>) - Static method in class org.instancio.Select
-
Select all fields matching the specified predicate.
- FieldSelectorBuilder - Interface in org.instancio
-
A builder for constructing predicate-based field selectors.
- file() - Element in annotation type org.instancio.feed.Feed.Source
-
Specifies the path to a file on the filesystem containing the data for a feed.
- file(String...) - Method in interface org.instancio.generators.IoGenerators
-
Generator for
Fileobjects. - file(String...) - Method in interface org.instancio.generators.IoSpecs
-
Generator for
Fileobjects. - file(Generator<String>) - Method in interface org.instancio.generator.specs.URLGeneratorSpec
-
Specifies a generator for the file name.
- file(Generator<String>) - Method in interface org.instancio.generator.specs.URLSpec
- FilePathSpec<T> - Interface in org.instancio.generator.specs
- FileSpec - Interface in org.instancio.generator.specs
-
Spec for generating
Filevalues. - filter(TargetSelector, FilterPredicate<V>) - Method in interface org.instancio.BaseApi
-
Filters generated values using given
predicate. - filter(TargetSelector, FilterPredicate<V>) - Method in interface org.instancio.InstancioApi
-
Filters generated values using given
predicate. - filter(TargetSelector, FilterPredicate<V>) - Method in interface org.instancio.InstancioCartesianProductApi
-
Filters generated values using given
predicate. - FilterPredicate<T> - Interface in org.instancio
-
A predicate for testing values using the
BaseApi.filter(TargetSelector, FilterPredicate)method. - finance() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Provides access to finance-related generators.
- finance() - Method in interface org.instancio.generators.Generators
-
Provides access to finance-related generators.
- finance() - Method in interface org.instancio.generators.ValueSpecs
-
Provides access to finance-related generators.
- FinanceGenerators - Interface in org.instancio.generators
-
Contains built-in finance-related generators.
- FinanceSpecs - Interface in org.instancio.generators
-
Provides finance-related generators.
- FLOAT_MAX - Static variable in class org.instancio.settings.Keys
-
Specifies maximum value for floats; default is 10000; property name
float.max. - FLOAT_MIN - Static variable in class org.instancio.settings.Keys
-
Specifies minimum value for floats; default is 1; property name
float.min. - FLOAT_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a
nullcan be generated for Float type; default isfalse; property namefloat.nullable. - floatRange(float, float) - Method in interface org.instancio.Random
-
Returns a random
floatwithin the given range. - floats() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Generator for
Floatvalues. - floats() - Method in interface org.instancio.generators.Generators
-
Generator for
Floatvalues. - floats() - Method in interface org.instancio.generators.ValueSpecs
-
Generator for
Floatvalues. - floatSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
Floatspec for the given property name. - FloatSpec - Interface in org.instancio.generator.specs
-
Spec for generating
Floatvalues. - formatOptions(FormatOptionsProvider) - Method in interface org.instancio.FeedApi
-
Specifies the data format options of a
Feed, for example: - formatOptions(FormatOptionsProvider) - Method in interface org.instancio.InstancioFeedApi
-
Specifies the data format options of a
Feed, for example: - FormatOptionsProvider - Interface in org.instancio.feed
-
Provides a
FormatOptionsProvider.FormatOptionsusing the specifiedFormatOptionsProvider.FormatOptionsFactory. - FormatOptionsProvider.FormatOptions - Interface in org.instancio.feed
-
Marker interface for supported data formats.
- FormatOptionsProvider.FormatOptions.CsvFormatOptions - Interface in org.instancio.feed
-
Interface for configuring CSV data format options.
- FormatOptionsProvider.FormatOptionsFactory - Interface in org.instancio.feed
-
Creates
FormatOptionsProvider.FormatOptionsobjects for supported data format types. - formatted() - Method in interface org.instancio.generator.specs.bra.CnpjGeneratorSpec
-
Format the CNPJ output.
- formatted() - Method in interface org.instancio.generator.specs.bra.CnpjSpec
-
Format the CNPJ output.
- formatted() - Method in interface org.instancio.generator.specs.bra.CpfGeneratorSpec
-
Format the CPF output.
- formatted() - Method in interface org.instancio.generator.specs.bra.CpfSpec
-
Format the CPF output.
- formatType(FeedFormatType) - Method in interface org.instancio.FeedApi
-
Specifies the data format type for the feed, such as CSV (by default) or JSON, for example:
- formatType(FeedFormatType) - Method in interface org.instancio.InstancioFeedApi
-
Specifies the data format type for the feed, such as CSV (by default) or JSON, for example:
- fragment(Generator<String>) - Method in interface org.instancio.generator.specs.URIGeneratorSpec
-
Specifies a generator for the fragmentGenerator.
- fragment(Generator<String>) - Method in interface org.instancio.generator.specs.URISpec
-
Specifies a generator for the fragmentGenerator.
- from(Map<Object, Object>) - Static method in interface org.instancio.settings.Settings
-
Create settings from the given map.
- from(Settings) - Static method in interface org.instancio.settings.Settings
-
Create settings from the given settings.
- fromCidr(String) - Method in interface org.instancio.generator.specs.Ip4GeneratorSpec
-
Generates IPv4 address from CIDR notation, for example:
fromCidr("192.168.1.0/24"). - fromCidr(String) - Method in interface org.instancio.generator.specs.Ip4Spec
- FunctionProvider - Interface in org.instancio.feed
-
A marker interface for classes that provide a method for handling
FeedSpecAnnotations.FunctionSpec. - future() - Method in interface org.instancio.generator.specs.InstantGeneratorSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.InstantSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.LocalDateSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.LocalDateTimeGeneratorSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.LocalDateTimeSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.LocalTimeGeneratorSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.LocalTimeSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.OffsetDateTimeGeneratorSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.OffsetDateTimeSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.OffsetTimeGeneratorSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.OffsetTimeSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.TemporalGeneratorSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.TemporalSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.YearMonthSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.YearSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.ZonedDateTimeGeneratorSpec
-
Generate a value in the future.
- future() - Method in interface org.instancio.generator.specs.ZonedDateTimeSpec
-
Generate a value in the future.
G
- 1. Generating values using methods defined by a feed - Search tag in interface org.instancio.feed.Feed
- Section
- gen() - Static method in class org.instancio.Instancio
-
A shorthand API for generating simple value types, such as strings, numbers, dates, etc.
- generate(Predicate<S>, GeneratorSpec<T>) - Method in interface org.instancio.GivenOriginDestination
-
Generates values using arbitrary generator specs.
- generate(Predicate<S>, GeneratorSpecProvider<T>) - Method in interface org.instancio.GivenOriginDestination
-
Generates values using built-in generators provided by the
genparameter, of typeGenerators. - generate(GeneratorSpec<T>) - Method in interface org.instancio.ValueOf
-
Generates values using arbitrary generator specs.
- generate(GeneratorSpecProvider<T>) - Method in interface org.instancio.ValueOf
-
Generates values using built-in generators provided by the
genparameter, of typeGenerators. - generate(Random) - Method in interface org.instancio.generator.Generator
-
Returns a generated value.
- generate(TargetSelector, GeneratorSpec<T>) - Method in interface org.instancio.GivenOriginPredicate
-
Generates values using arbitrary generator specs.
- generate(TargetSelector, GeneratorSpec<V>) - Method in interface org.instancio.BaseApi
-
Customises values using arbitrary generator specs.
- generate(TargetSelector, GeneratorSpec<V>) - Method in interface org.instancio.InstancioApi
-
Customises values using arbitrary generator specs.
- generate(TargetSelector, GeneratorSpec<V>) - Method in interface org.instancio.InstancioCartesianProductApi
-
Customises values using arbitrary generator specs.
- generate(TargetSelector, GeneratorSpecProvider<T>) - Method in interface org.instancio.GivenOriginPredicate
-
Generates values using built-in generators provided by the
genparameter, of typeGenerators. - generate(TargetSelector, GeneratorSpecProvider<V>) - Method in interface org.instancio.BaseApi
-
Customises values using built-in generators provided by the
genparameter, of typeGenerators. - generate(TargetSelector, GeneratorSpecProvider<V>) - Method in interface org.instancio.InstancioApi
-
Customises values using built-in generators provided by the
genparameter, of typeGenerators. - generate(TargetSelector, GeneratorSpecProvider<V>) - Method in interface org.instancio.InstancioCartesianProductApi
-
Customises values using built-in generators provided by the
genparameter, of typeGenerators. - generateElements() - Method in class org.instancio.generator.hints.CollectionHint
-
Indicates the number of elements the engine should generate and insert into the collection.
- generateElements(int) - Method in class org.instancio.generator.hints.CollectionHint.Builder
-
Indicates how many elements the engine should generate and insert into the collection.
- generateEntries() - Method in class org.instancio.generator.hints.MapHint
-
Indicates the number of entries the engine should generate and insert into the map.
- generateEntries(int) - Method in class org.instancio.generator.hints.MapHint.Builder
-
Indicates how many entries the engine should generate and insert into the map.
- Generate random objects - Search tag in org.instancio.BaseApi.supply(TargetSelector, Generator<V>)
- Section
- Generate random objects - Search tag in org.instancio.BaseApi.supply(TargetSelector, Generator<V>)
- Section
- Generate random objects - Search tag in org.instancio.BaseApi.supply(TargetSelector, Generator<V>)
- Section
- Generator<T> - Interface in org.instancio.generator
-
A class for generating values of a specific type.
- GeneratorContext - Class in org.instancio.generator
-
Provides additional information, such as settings and a random instance to generators that require it.
- GeneratorContext(Settings, Random) - Constructor for class org.instancio.generator.GeneratorContext
- Generators - Interface in org.instancio.generators
-
Defines all built-in generators available via the
InstancioApi.generate(TargetSelector, GeneratorSpecProvider). - GeneratorSpec<T> - Interface in org.instancio.generator
-
A marker interface serving as the base class for all
Generators. - GeneratorSpecProvider<V> - Interface in org.instancio
-
Provides access to built-in generators that support customisation of generated values using the API.
- get() - Method in interface org.instancio.generator.ValueSpec
-
Generates a single value.
- get() - Method in interface org.instancio.Result
-
Returns the created object.
- get() - Method in interface org.instancio.TypeToken
-
Returns the type to be created.
- get() - Method in interface org.instancio.TypeTokenSupplier
-
Returns the type to be created.
- get(String) - Static method in class org.instancio.settings.Keys
-
Returns a
SettingKeyinstance with the given property key. - get(Class<T>) - Method in class org.instancio.generator.Hints
-
Returns a hint with the specified type.
- get(DataSourceProvider.DataSourceFactory) - Method in interface org.instancio.feed.DataSourceProvider
-
Gets a
DataSourcefrom the givenfactory. - get(FeedProvider.FeedBuilderFactory) - Method in interface org.instancio.feed.FeedProvider
-
Configures a
Feedinstance using the specified builder. - get(FormatOptionsProvider.FormatOptionsFactory) - Method in interface org.instancio.feed.FormatOptionsProvider
-
Configures format options using the given
factory. - get(SettingKey<T>) - Method in interface org.instancio.settings.Settings
-
Get setting value for given key.
- getAnnotationProcessor() - Method in interface org.instancio.spi.InstancioServiceProvider
-
Returns an
AnnotationProcessorimplementation. - getField() - Method in interface org.instancio.Node
-
Returns the field of this node, if available.
- getGenerator(Node, Generators) - Method in interface org.instancio.spi.InstancioServiceProvider.GeneratorProvider
-
Returns a generator spec for the specified
node. - getGeneratorProvider() - Method in interface org.instancio.spi.InstancioServiceProvider
-
Returns a
GeneratorProviderimplementation. - getInputStream() - Method in interface org.instancio.feed.DataSource
-
Returns an input stream containing the data for a
Feed. - GetMethodSelector<T,
R> - Interface in org.instancio -
A selector that matches a field using a getter method reference.
- getName() - Method in interface org.instancio.feed.DataSource
-
Returns the name of this data source, if applicable (for example, file name).
- getParent() - Method in interface org.instancio.Node
-
Returns the parent of this node, or
nullif this node is the root. - getSeed() - Method in interface org.instancio.Random
-
Returns the seed value used by the random number generator.
- getSeed() - Method in interface org.instancio.Result
-
Returns the seed that was used to populate the created object.
- getSetter() - Method in interface org.instancio.Node
-
Returns the setter of this node, if available, and if
Keys.ASSIGNMENT_TYPEis set toAssignmentType.METHOD. - getSetter(Node) - Method in interface org.instancio.spi.InstancioServiceProvider.SetterMethodResolver
-
Returns the setter method for the given
node. - getSetterMethodResolver() - Method in interface org.instancio.spi.InstancioServiceProvider
-
Returns a
SetterMethodResolverimplementation. - getSettings() - Method in class org.instancio.generator.GeneratorContext
-
Returns a read-only instance of the settings used by Instancio.
- getSettings() - Method in interface org.instancio.spi.ServiceProviderContext
-
Returns a read-only instance of the
Settings. - getSpec(Generators) - Method in interface org.instancio.GeneratorSpecProvider
-
Returns a generator spec.
- getSubtype(Class<?>) - Method in interface org.instancio.spi.InstancioServiceProvider.TypeResolver
-
Returns a subtype for the given
type. - getSubtypeMap() - Method in interface org.instancio.settings.Settings
-
Returns a read-only view of the subtype map.
- getTargetClass() - Method in interface org.instancio.Node
-
Returns the target class of this node.
- GETTER - Enum constant in enum org.instancio.settings.BeanValidationTarget
-
Indicates that constraints are specified on getters.
- getTypeInstantiator() - Method in interface org.instancio.spi.InstancioServiceProvider
-
Returns a
TypeInstantiatorimplementation. - getTypeResolver() - Method in interface org.instancio.spi.InstancioServiceProvider
-
Returns a
TypeResolverimplementation. - getUnusedSelectorMap() - Method in exception class org.instancio.exception.UnusedSelectorException
- given(Class<T>) - Static method in class org.instancio.Assign
-
Creates a conditional assignment for a given
origintype. - given(GetMethodSelector<T, R>) - Static method in class org.instancio.Assign
-
Creates a conditional assignment for a given
originmethod reference and one or moredestinationselectors. - given(TargetSelector) - Static method in class org.instancio.Assign
-
Creates a conditional for a given
originand one or moredestinationselectors. - given(TargetSelector, TargetSelector) - Static method in class org.instancio.Assign
-
Creates a conditional assigment for a given pair of
originanddestinationselectors. - GivenOrigin - Interface in org.instancio
-
Represents an origin selector of a conditional assignment.
- GivenOriginDestination - Interface in org.instancio
-
Represents an origin and a destination of a conditional assigment.
- GivenOriginDestinationAction - Interface in org.instancio
-
Defines optional methods that can be chained to
Assign.given(TargetSelector)builder expression. - GivenOriginPredicate - Interface in org.instancio
-
Defines methods one of which follow the
Assign.given(TargetSelector)builder expressions to create an assignment. - GivenOriginPredicateAction - Interface in org.instancio
-
Defines optional methods that can be chained to
Assign.given(TargetSelector, TargetSelector)builder expression. - GroupableSelector - Interface in org.instancio
-
A marker for selectors that can be grouped using
Select.all(GroupableSelector...).
H
- hash() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Generator for various types of hashes.
- hash() - Method in interface org.instancio.generators.Generators
-
Generator for various types of hashes.
- hash() - Method in interface org.instancio.generators.ValueSpecs
-
Generator for various types of hashes.
- HashGeneratorSpec - Interface in org.instancio.generator.specs
-
Spec for generating hashes
- HashSpec - Interface in org.instancio.generator.specs
-
Spec for generating hashes
- hex() - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Generates a hexadecimal string, uppercase by default, that consists of characters
[0-9A-F] - hex() - Method in interface org.instancio.generator.specs.StringSpec
-
Generates a hexadecimal string, uppercase by default, that consists of characters
[0-9A-F] - HEX - Enum constant in enum org.instancio.settings.StringType
-
Represents a hexadecimal string, uppercase by default, that consists of characters
[0-9A-F] - Hint<T> - Interface in org.instancio.generator
-
A hint that can be passed from a generator to the engine.
- hints() - Method in interface org.instancio.generator.Generator
-
Hints provided by the generator to the engine.
- Hints - Class in org.instancio.generator
-
Hints are provided by
Generatorimplementations to the engine to support more flexibility in how objects are populated. - Hints.Builder - Class in org.instancio.generator
-
Builder for constructing
Hints. - host(Generator<String>) - Method in interface org.instancio.generator.specs.URIGeneratorSpec
-
Specifies a generator for the host name.
- host(Generator<String>) - Method in interface org.instancio.generator.specs.URISpec
-
Specifies a generator for the host name.
- host(Generator<String>) - Method in interface org.instancio.generator.specs.URLGeneratorSpec
-
Specifies a generator for the host name.
- host(Generator<String>) - Method in interface org.instancio.generator.specs.URLSpec
I
- id() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Provides access to identifier generators.
- id() - Method in interface org.instancio.generators.Generators
-
Provides access to identifier generators.
- id() - Method in interface org.instancio.generators.ValueSpecs
-
Provides access to identifier generators.
- IdGenerators - Interface in org.instancio.generators
-
Contains built-in generators for various types of identifiers.
- IdSpecs - Interface in org.instancio.generators
-
Provides generators for various types of identifiers.
- ignore(TargetSelector) - Method in interface org.instancio.BaseApi
-
Specifies that a class or field should be ignored.
- ignore(TargetSelector) - Method in interface org.instancio.InstancioApi
-
Specifies that a class or field should be ignored.
- ignore(TargetSelector) - Method in interface org.instancio.InstancioCartesianProductApi
-
Specifies that a class or field should be ignored.
- IGNORE - Enum constant in enum org.instancio.settings.OnSetFieldError
-
Ignore the error and continue populating the object.
- IGNORE - Enum constant in enum org.instancio.settings.OnSetMethodError
-
Ignore the error and continue populating the object.
- IGNORE - Enum constant in enum org.instancio.settings.OnSetMethodNotFound
-
Ignore the error and continue populating the object.
- IGNORE - Enum constant in enum org.instancio.settings.OnSetMethodUnmatched
-
Ignore setters that do not have a corresponding field.
- Ignore certain fields or classes - Search tag in class org.instancio.Instancio
- Section
- ignoreUnused() - Method in interface org.instancio.generator.specs.EmitGeneratorSpec
-
Specifies that if any of the provided items were not emitted, they should be ignored (the default is to throw an exception).
- individual() - Method in interface org.instancio.generator.specs.rus.InnGeneratorSpec
-
Generate an individual INN.
- individual() - Method in interface org.instancio.generator.specs.rus.InnSpec
-
Generate an individual INN.
- init(GeneratorContext) - Method in interface org.instancio.generator.Generator
-
An optional method for generators that need to initialise state before generating values.
- init(ServiceProviderContext) - Method in interface org.instancio.spi.InstancioServiceProvider
-
An optional method that can be used by implementations that require access to the context information.
- inn() - Method in interface org.instancio.generators.rus.RusIdGenerators
-
Generates Russian taxpayer identification number (INN).
- inn() - Method in interface org.instancio.generators.rus.RusIdSpecs
-
Generates Russian taxpayer identification number (INN).
- InnGeneratorSpec - Interface in org.instancio.generator.specs.rus
-
Spec for generating Russian taxpayer identification number' (INN).
- InnSpec - Interface in org.instancio.generator.specs.rus
-
Spec for generating Russian taxpayer identification number' (INN).
- Instancio - Class in org.instancio
-
Instancio API for creating instances of a class.
- INSTANCIO_SOURCE_SAMPLES - Static variable in class org.instancio.settings.Keys
-
Specifies the number of samples for the
@InstancioSourceannotation from theinstancio-junitmodule; default is 100; property nameinstancio.source.samples. - InstancioApi<T> - Interface in org.instancio
-
Instancio API for generating instances of a class populated with random data.
- InstancioApiException - Exception Class in org.instancio.exception
-
Exception generated by incorrect usage of the API.
- InstancioApiException(String) - Constructor for exception class org.instancio.exception.InstancioApiException
- InstancioApiException(String, Throwable) - Constructor for exception class org.instancio.exception.InstancioApiException
- InstancioCartesianProductApi<T> - Interface in org.instancio
-
Provides an API for generating the Cartesian product.
- InstancioClassApi<T> - Interface in org.instancio
-
Instancio API for defining type parameters for generic classes.
- InstancioCollectionsApi<C> - Interface in org.instancio
-
Instancio API for generating collections populated with random data.
- InstancioException - Exception Class in org.instancio.exception
-
Base class for all exceptions thrown by Instancio.
- InstancioException(String) - Constructor for exception class org.instancio.exception.InstancioException
- InstancioException(String, Throwable) - Constructor for exception class org.instancio.exception.InstancioException
- InstancioFeedApi<F> - Interface in org.instancio
-
An API for customising the properties of a
Feed. - InstancioGenApi - Interface in org.instancio
-
A shorthand API for generating value types, such as strings, numbers, dates, etc.
- InstancioServiceProvider - Interface in org.instancio.spi
-
Instancio Service Provider Interface for providing custom: generator mappings via
InstancioServiceProvider.getGeneratorProvider()subtype mappings viaInstancioServiceProvider.getTypeResolver()class instantiation logic viaInstancioServiceProvider.getTypeInstantiator()setter resolution viaInstancioServiceProvider.getSetterMethodResolver()annotation processing viaInstancioServiceProvider.getAnnotationProcessor() - InstancioServiceProvider.AnnotationProcessor - Interface in org.instancio.spi
-
Allows customising generated values based on annotations.
- InstancioServiceProvider.AnnotationProcessor.AnnotationHandler - Annotation Type in org.instancio.spi
-
Denotes a method for handling annotations.
- InstancioServiceProvider.GeneratorProvider - Interface in org.instancio.spi
-
Provides custom
Generatorclasses. - InstancioServiceProvider.SetterMethodResolver - Interface in org.instancio.spi
-
Resolves setter method based on a given node when
Keys.ASSIGNMENT_TYPEis set toAssignmentType.METHOD. - InstancioServiceProvider.TypeInstantiator - Interface in org.instancio.spi
-
Provides custom instantiation logic.
- InstancioServiceProvider.TypeResolver - Interface in org.instancio.spi
-
Resolves subtype based on a given class.
- InstancioSpiException - Exception Class in org.instancio.spi
-
Exception generated by incorrect usage of the SPI.
- InstancioSpiException(String) - Constructor for exception class org.instancio.spi.InstancioSpiException
- InstancioTerminatingException - Exception Class in org.instancio.exception
-
This exception (and its subclasses) indicates an unrecoverable error and propagates all the way up to the user.
- InstancioTerminatingException(String) - Constructor for exception class org.instancio.exception.InstancioTerminatingException
- InstancioTerminatingException(String, Throwable) - Constructor for exception class org.instancio.exception.InstancioTerminatingException
- instant() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises generated
Instantvalues. - instant() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises generated
Instantvalues. - InstantGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for
Instant. - instantiate(Class<?>) - Method in interface org.instancio.spi.InstancioServiceProvider.TypeInstantiator
-
Instantiates an instance of the specified type.
- instantSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns an
Instantspec for the given property name. - InstantSpec - Interface in org.instancio.generator.specs
-
Spec for generating
Instantvalues. - INTEGER_MAX - Static variable in class org.instancio.settings.Keys
-
Specifies maximum value for integers; default is 10000; property name
integer.max. - INTEGER_MIN - Static variable in class org.instancio.settings.Keys
-
Specifies minimum value for integers; default is 1; property name
integer.min. - INTEGER_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a
nullcan be generated for Integer type; default isfalse; property nameinteger.nullable. - IntegerSpec - Interface in org.instancio.generator.specs
-
Spec for generating
Integervalues. - InternalApi - Annotation Type in org.instancio.documentation
-
Denotes internal APIs that are not intended for external use.
- IntervalSpec<T> - Interface in org.instancio.generator.specs
-
Spec for generating intervals of various types, such as numeric and temporal values.
- intervalStarting(T) - Method in interface org.instancio.generators.ValueSpecs
-
A spec for generating intervals of various types, such as numeric and temporal values.
- IntervalSupplier<T> - Interface in org.instancio
-
A supplier of
startandendinterval values. - intRange(int, int) - Method in interface org.instancio.Random
-
Returns a random
intwithin the given range. - ints() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Generator for
Integervalues. - ints() - Method in interface org.instancio.generators.Generators
-
Generator for
Integervalues. - ints() - Method in interface org.instancio.generators.ValueSpecs
-
Generator for
Integervalues. - intSeq() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
An
Integersequence generator. - intSeq() - Method in interface org.instancio.generators.Generators
-
An
Integersequence generator. - intSeq() - Method in interface org.instancio.generators.ValueSpecs
-
An
Integersequence generator. - intSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
Integerspec for the given property name. - INVOKE - Enum constant in enum org.instancio.settings.OnSetMethodUnmatched
-
Invoke setters that do not have a corresponding field.
- io() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Provides access to IO generators.
- io() - Method in interface org.instancio.generators.Generators
-
Provides access to IO generators.
- io() - Method in interface org.instancio.generators.ValueSpecs
-
Provides access to IO generators.
- IoGenerators - Interface in org.instancio.generators
-
Contains built-in generators for
java.ioclasses. - IoSpecs - Interface in org.instancio.generators
-
Provides generators for
java.ioclasses. - ip4() - Method in interface org.instancio.generators.NetGenerators
-
Generates IPv4 address.
- ip4() - Method in interface org.instancio.generators.NetSpecs
-
Generates IPv4 address.
- Ip4GeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for IPv4.
- Ip4Spec - Interface in org.instancio.generator.specs
-
Spec for generating IPv4 addresses.
- is(T) - Method in interface org.instancio.GivenOrigin
-
Checks if the origin value is equal to given
valueusingObjects.equals(Object, Object). - is(T) - Static method in class org.instancio.When
-
A predicate that returns
trueif values are equal usingObjects.equals(Object, Object). - isbn() - Method in interface org.instancio.generators.IdGenerators
-
Generates ISBN numbers.
- isbn() - Method in interface org.instancio.generators.IdSpecs
-
Generates ISBN numbers.
- IsbnGeneratorSpec - Interface in org.instancio.generator.specs
-
Spec for generating ISBN.
- IsbnSpec - Interface in org.instancio.generator.specs
-
Spec for generating ISBN.
- isIn(T...) - Method in interface org.instancio.GivenOrigin
-
Checks if the origin value is equal to any of given
valuesusingObjects.equals(Object, Object). - isIn(T...) - Static method in class org.instancio.When
-
A predicate that checks whether a value is equal to any element in the
valuesarray usingObjects.equals(Object, Object). - isLocked() - Method in interface org.instancio.settings.Settings
-
Checks if this instance is locked for modifications.
- isNot(T) - Method in interface org.instancio.GivenOrigin
-
Checks if the origin value is not equal to given
valueusingObjects.equals(Object, Object). - isNot(T) - Static method in class org.instancio.When
-
A predicate that returns
trueif values are not equal usingObjects.equals(Object, Object). - isNotNull() - Static method in class org.instancio.When
-
A predicate that checks if a value is not
null. - isNull() - Static method in class org.instancio.When
-
A predicate that checks if a value is
null. - item(T, int) - Method in interface org.instancio.generator.specs.EmitGeneratorSpec
-
Emit given
itemnnumber of times. - items(Iterable<? extends T>) - Method in interface org.instancio.generator.specs.EmitGeneratorSpec
-
Emit given
items. - items(T...) - Method in interface org.instancio.generator.specs.EmitGeneratorSpec
-
Emit given
items.
J
- JPA_ENABLED - Static variable in class org.instancio.settings.Keys
-
Specifies whether values should be generated based on JPA annotations, such as
@Column.length; default isfalse; property namejpa.enabled. - JSON - Enum constant in enum org.instancio.settings.FeedFormatType
-
JSON format.
- juridical() - Method in interface org.instancio.generator.specs.rus.InnGeneratorSpec
-
Generate a juridical INN.
- juridical() - Method in interface org.instancio.generator.specs.rus.InnSpec
-
Generate a juridical INN.
K
- Keys - Class in org.instancio.settings
-
Defines all keys supported by Instancio.
L
- lat() - Method in interface org.instancio.generator.specs.CoordinateGeneratorSpec
-
Specifies that valid latitude values should be generated.
- lat() - Method in interface org.instancio.generator.specs.CoordinateSpec
- leftToRight() - Method in interface org.instancio.generator.specs.Mod11GeneratorSpec
-
Specifies that the Mod11 checksum must be done from the leftmost to the rightmost digit (default behaviour is right to left).
- leftToRight() - Method in interface org.instancio.generator.specs.Mod11Spec
-
Specifies that the Mod11 checksum must be done from the leftmost to the rightmost digit (default behaviour is right to left).
- length(int) - Method in interface org.instancio.generator.specs.ArrayGeneratorSpec
-
length of array to generate.
- length(int) - Method in interface org.instancio.generator.specs.EmailGeneratorSpec
-
Specifies email address length.
- length(int) - Method in interface org.instancio.generator.specs.EmailSpec
- length(int) - Method in interface org.instancio.generator.specs.LuhnGeneratorSpec
-
Length of the number to generate (default value is
16). - length(int) - Method in interface org.instancio.generator.specs.LuhnSpec
- length(int) - Method in interface org.instancio.generator.specs.Mod10GeneratorSpec
-
Length of the number to generate (default value is
16). - length(int) - Method in interface org.instancio.generator.specs.Mod10Spec
- length(int) - Method in interface org.instancio.generator.specs.Mod11GeneratorSpec
-
Length of the number to generate (default value is
16). - length(int) - Method in interface org.instancio.generator.specs.Mod11Spec
-
Length of the number to generate (default value is
16). - length(int) - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Specifies the length of the string to generate as returned by
String.length(), or the number of code points when generating aStringGeneratorSpec.unicode(UnicodeBlock...)string. - length(int) - Method in interface org.instancio.generator.specs.StringSpec
- length(int, int) - Method in interface org.instancio.generator.specs.EmailGeneratorSpec
-
Specifies email address length range.
- length(int, int) - Method in interface org.instancio.generator.specs.EmailSpec
- length(int, int) - Method in interface org.instancio.generator.specs.LuhnGeneratorSpec
-
Generate a number of random length within the specified range.
- length(int, int) - Method in interface org.instancio.generator.specs.LuhnSpec
- length(int, int) - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Specifies the length of the string to generate as returned by
String.length(), or the number of code points when generating aStringGeneratorSpec.unicode(UnicodeBlock...)string. - length(int, int) - Method in interface org.instancio.generator.specs.StringSpec
- lenient() - Method in interface org.instancio.InstancioApi
-
Disables strict mode in which unused selectors trigger an error.
- lenient() - Method in interface org.instancio.InstancioCartesianProductApi
-
Disables strict mode in which unused selectors trigger an error.
- lenient() - Method in interface org.instancio.LenientModeApi
-
Disables strict mode in which unused selectors trigger an error.
- lenient() - Method in interface org.instancio.LenientSelector
-
Marks this selector as lenient, which prevents the selector from producing "unused selector" error if it does not match any target.
- lenient() - Method in interface org.instancio.ScopeableSelector
-
Marks this selector as lenient, which prevents the selector from producing "unused selector" error if it does not match any target.
- LENIENT - Enum constant in enum org.instancio.settings.Mode
-
In lenient mode, unused selectors are ignored and no exception is triggered.
- LenientModeApi - Interface in org.instancio
-
Provides support for lenient mode.
- LenientSelector - Interface in org.instancio
-
A lenient selector does not trigger the "unused selector" error if it does not match any targets.
- Limitations of assignments - Search tag in org.instancio.BaseApi.assign(Assignment...)
- Section
- Limitations of assignments - Search tag in org.instancio.BaseApi.assign(Assignment...)
- Section
- Limitations of assignments - Search tag in org.instancio.BaseApi.assign(Assignment...)
- Section
- lineSeparator(String) - Method in interface org.instancio.generator.specs.CsvGeneratorSpec
-
Specifies the line separator.
- lineSeparator(String) - Method in interface org.instancio.generator.specs.CsvSpec
-
Specifies the line separator.
- list(int) - Method in interface org.instancio.generator.ValueSpec
-
Generates a list of values of specified size.
- localDate() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises generated
LocalDatevalues. - localDate() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises generated
LocalDatevalues. - localDateSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
LocalDatespec for the given property name. - LocalDateSpec - Interface in org.instancio.generator.specs
-
Spec for generating
LocalDatevalues. - localDateTime() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises generated
LocalDateTimevalues. - localDateTime() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises generated
LocalDateTimevalues. - LocalDateTimeGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for
LocalDateTime. - localDateTimeSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
LocalDateTimespec for the given property name. - LocalDateTimeSpec - Interface in org.instancio.generator.specs
-
Spec for generating
LocalDateTimevalues. - localTime() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises generated
LocalTimevalues. - localTime() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises generated
LocalTimevalues. - LocalTimeGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for
LocalTime. - localTimeSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
LocalTimespec for the given property name. - LocalTimeSpec - Interface in org.instancio.generator.specs
-
Spec for generating
LocalTimevalues. - lock() - Method in interface org.instancio.settings.Settings
-
Locks these settings for further modifications, making this instance immutable.
- lon() - Method in interface org.instancio.generator.specs.CoordinateGeneratorSpec
-
Specifies that valid longitude values should be generated.
- lon() - Method in interface org.instancio.generator.specs.CoordinateSpec
- LONG_MAX - Static variable in class org.instancio.settings.Keys
-
Specifies maximum value for longs; default is 10000; property name
long.max. - LONG_MIN - Static variable in class org.instancio.settings.Keys
-
Specifies minimum value for longs; default is 1; property name
long.min. - LONG_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a
nullcan be generated for Long type; default isfalse; property namelong.nullable. - longRange(long, long) - Method in interface org.instancio.Random
-
Returns a random
longwithin the given range. - longs() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Generator for
Longvalues. - longs() - Method in interface org.instancio.generators.Generators
-
Generator for
Longvalues. - longs() - Method in interface org.instancio.generators.ValueSpecs
-
Generator for
Longvalues. - longSeq() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
A
Longsequence generator. - longSeq() - Method in interface org.instancio.generators.Generators
-
A
Longsequence generator. - longSeq() - Method in interface org.instancio.generators.ValueSpecs
-
A
Longsequence generator. - longSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
Longspec for the given property name. - LongSpec - Interface in org.instancio.generator.specs
-
Spec for generating
Longvalues. - loremIpsum() - Method in interface org.instancio.generators.TextGenerators
-
Generates "Lorem ipsum" text.
- loremIpsum() - Method in interface org.instancio.generators.TextSpecs
-
Generates "Lorem ipsum" text.
- LoremIpsumGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for producing "Lorem ipsum..." text.
- LoremIpsumSpec - Interface in org.instancio.generator.specs
-
Spec for generating "lorem ipsum" text.
- LOWER - Enum constant in enum org.instancio.settings.StringCase
-
Represents lowercase strings
[a-z]. - lowerCase() - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Generates a lowercase string that consists of characters
[a-z]. - lowerCase() - Method in interface org.instancio.generator.specs.StringSpec
- lowerCaseAlphabetic(int) - Method in interface org.instancio.Random
-
Generates a lower case String comprised of
[a-z]. - lowerCaseCharacter() - Method in interface org.instancio.Random
-
Returns a random lower alphabetic character,
[a-z]. - luhn() - Method in interface org.instancio.generators.ChecksumGenerators
-
Generates numbers that pass the Luhn checksum algorithm.
- luhn() - Method in interface org.instancio.generators.ChecksumSpecs
-
Generates numbers that pass the Luhn checksum algorithm.
- LuhnGeneratorSpec - Interface in org.instancio.generator.specs
-
A spec for generating numbers that pass the Luhn checksum algorithm.
- LuhnSpec - Interface in org.instancio.generator.specs
-
A spec for generating numbers that pass the Luhn checksum algorithm.
M
- 3. Mapping feed data to an object using applyFeed() - Search tag in interface org.instancio.feed.Feed
- Section
- male() - Method in interface org.instancio.generator.specs.pol.PeselGeneratorSpec
-
Specifies that male PESEL should be generated.
- male() - Method in interface org.instancio.generator.specs.pol.PeselSpec
-
Specifies that male PESEL should be generated.
- map() - Method in interface org.instancio.generators.Generators
-
Generator for maps.
- map(Function<T, R>) - Method in interface org.instancio.generator.ValueSpec
-
Maps the generated value using the specified function.
- MAP_KEYS_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a
nullcan be generated for map keys; default isfalse; property namemap.keys.nullable. - MAP_MAX_SIZE - Static variable in class org.instancio.settings.Keys
-
Specifies maximum size for maps; default is 6; property name
map.max.size. - MAP_MIN_SIZE - Static variable in class org.instancio.settings.Keys
-
Specifies minimum size for maps; default is 2; property name
map.min.size. - MAP_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a
nullcan be generated for maps; default isfalse; property namemap.nullable. - MAP_VALUES_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a
nullcan be generated for map values; default isfalse; property namemap.values.nullable. - MapGeneratorSpec<K,
V> - Interface in org.instancio.generator.specs -
Generator spec for maps.
- MapHint - Class in org.instancio.generator.hints
-
This hint is for generators that create maps.
- MapHint.Builder - Class in org.instancio.generator.hints
-
Builder class for this hint.
- mapType(Class<?>, Class<?>) - Method in interface org.instancio.settings.Settings
-
Maps a supertype to a specified subtype, allowing the creation of instances of the subtype when the supertype is requested.
- masterCard() - Method in interface org.instancio.generator.specs.CreditCardGeneratorSpec
-
Specifies that MasterCard credit card numbers should be generated.
- masterCard() - Method in interface org.instancio.generator.specs.CreditCardSpec
- matching(String) - Method in interface org.instancio.FieldSelectorBuilder
-
Matches field names using the specified regular expression.
- math() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Provides generators for
java.mathclasses. - math() - Method in interface org.instancio.generators.Generators
-
Provides generators for
java.mathclasses. - math() - Method in interface org.instancio.generators.ValueSpecs
-
Provides generators for
java.mathclasses. - MathGenerators - Interface in org.instancio.generators
-
Contains built-in generators for
java.mathclasses. - MathSpecs - Interface in org.instancio.generators
-
Provides generators for
java.mathclasses. - max(long, TemporalUnit) - Method in interface org.instancio.generator.specs.DurationGeneratorSpec
-
Generate a
Durationless than or equal to the specified amount. - max(long, TemporalUnit) - Method in interface org.instancio.generator.specs.DurationSpec
- max(Byte) - Method in interface org.instancio.generator.specs.ByteSpec
- max(Double) - Method in interface org.instancio.generator.specs.DoubleSpec
- max(Float) - Method in interface org.instancio.generator.specs.FloatSpec
- max(Integer) - Method in interface org.instancio.generator.specs.IntegerSpec
- max(Long) - Method in interface org.instancio.generator.specs.LongSpec
- max(Short) - Method in interface org.instancio.generator.specs.ShortSpec
- max(BigDecimal) - Method in interface org.instancio.generator.specs.BigDecimalGeneratorSpec
-
Specifies the upper bound.
- max(BigDecimal) - Method in interface org.instancio.generator.specs.BigDecimalSpec
-
Specifies the upper bound.
- max(BigInteger) - Method in interface org.instancio.generator.specs.BigIntegerSpec
- max(Instant) - Method in interface org.instancio.generator.specs.InstantGeneratorSpec
-
Specifies the upper bound.
- max(Instant) - Method in interface org.instancio.generator.specs.InstantSpec
-
Specifies the upper bound.
- max(LocalDate) - Method in interface org.instancio.generator.specs.LocalDateSpec
-
Specifies the upper bound.
- max(LocalDateTime) - Method in interface org.instancio.generator.specs.LocalDateTimeSpec
-
Specifies the upper bound.
- max(LocalTime) - Method in interface org.instancio.generator.specs.LocalTimeSpec
-
Specifies the upper bound.
- max(MonthDay) - Method in interface org.instancio.generator.specs.MonthDayGeneratorSpec
-
Generate a
MonthDayvalue on or before the specified day. - max(MonthDay) - Method in interface org.instancio.generator.specs.MonthDaySpec
-
Generate a
MonthDayvalue on or before the specified day. - max(OffsetDateTime) - Method in interface org.instancio.generator.specs.OffsetDateTimeGeneratorSpec
-
Specifies the upper bound.
- max(OffsetDateTime) - Method in interface org.instancio.generator.specs.OffsetDateTimeSpec
-
Specifies the upper bound.
- max(OffsetTime) - Method in interface org.instancio.generator.specs.OffsetTimeGeneratorSpec
-
Specifies the upper bound.
- max(OffsetTime) - Method in interface org.instancio.generator.specs.OffsetTimeSpec
-
Specifies the upper bound.
- max(Year) - Method in interface org.instancio.generator.specs.YearSpec
-
Specifies the upper bound.
- max(YearMonth) - Method in interface org.instancio.generator.specs.YearMonthSpec
-
Specifies the upper bound.
- max(ZonedDateTime) - Method in interface org.instancio.generator.specs.ZonedDateTimeGeneratorSpec
-
Specifies the upper bound.
- max(ZonedDateTime) - Method in interface org.instancio.generator.specs.ZonedDateTimeSpec
-
Specifies the upper bound.
- max(T) - Method in interface org.instancio.generator.specs.NumberGeneratorSpec
-
Specifies the upper bound.
- max(T) - Method in interface org.instancio.generator.specs.NumberSpec
- max(T) - Method in interface org.instancio.generator.specs.TemporalGeneratorSpec
-
Specifies the upper bound.
- max(T) - Method in interface org.instancio.generator.specs.TemporalSpec
-
Specifies the upper bound.
- MAX_DEPTH - Static variable in class org.instancio.settings.Keys
-
Specifies the maximum depth of the generated object tree; default is
8; property namemax.depth. - MAX_GENERATION_ATTEMPTS - Static variable in class org.instancio.settings.Keys
-
The maximum number of attempts to generate an object for a given node; default is
1000; property namemax.generation.attempts. - maxLength(int) - Method in interface org.instancio.generator.specs.ArrayGeneratorSpec
-
Maximum length of array to generate.
- maxLength(int) - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Specifies the maximum length of the string to generate as returned by
String.length(), or the number of code points when generating aStringGeneratorSpec.unicode(UnicodeBlock...)string. - maxLength(int) - Method in interface org.instancio.generator.specs.StringSpec
- maxSize(int) - Method in interface org.instancio.generator.specs.CollectionGeneratorSpec
-
Maximum size of collection to generate.
- maxSize(int) - Method in interface org.instancio.generator.specs.EnumSetGeneratorSpec
-
Maximum size of
EnumSetto generate. - maxSize(int) - Method in interface org.instancio.generator.specs.MapGeneratorSpec
-
Maximum size of map to generate.
- maxSize(int) - Method in interface org.instancio.generator.specs.SizeGeneratorSpec
-
The maximum size of the object to generate.
- md5() - Method in interface org.instancio.generator.specs.HashGeneratorSpec
-
Specifies that an MD5 hash should be generated.
- md5() - Method in interface org.instancio.generator.specs.HashSpec
- merge(Settings) - Method in interface org.instancio.settings.Settings
-
Creates a new instance of settings by merging given settings with these settings.
- METHOD - Enum constant in enum org.instancio.settings.AssignmentType
-
Indicates that values should be set via setter methods.
- MethodModifier - Class in org.instancio.settings
-
A class containing modifier constants.
- min(long, TemporalUnit) - Method in interface org.instancio.generator.specs.DurationGeneratorSpec
-
Generate a
Durationgreater than or equal to the specified amount. - min(long, TemporalUnit) - Method in interface org.instancio.generator.specs.DurationSpec
- min(Byte) - Method in interface org.instancio.generator.specs.ByteSpec
- min(Double) - Method in interface org.instancio.generator.specs.DoubleSpec
- min(Float) - Method in interface org.instancio.generator.specs.FloatSpec
- min(Integer) - Method in interface org.instancio.generator.specs.IntegerSpec
- min(Long) - Method in interface org.instancio.generator.specs.LongSpec
- min(Short) - Method in interface org.instancio.generator.specs.ShortSpec
- min(BigDecimal) - Method in interface org.instancio.generator.specs.BigDecimalGeneratorSpec
-
Specifies the lower bound.
- min(BigDecimal) - Method in interface org.instancio.generator.specs.BigDecimalSpec
-
Specifies the lower bound.
- min(BigInteger) - Method in interface org.instancio.generator.specs.BigIntegerSpec
- min(Instant) - Method in interface org.instancio.generator.specs.InstantGeneratorSpec
-
Specifies the lower bound.
- min(Instant) - Method in interface org.instancio.generator.specs.InstantSpec
-
Specifies the lower bound.
- min(LocalDate) - Method in interface org.instancio.generator.specs.LocalDateSpec
-
Specifies the lower bound.
- min(LocalDateTime) - Method in interface org.instancio.generator.specs.LocalDateTimeSpec
-
Specifies the lower bound.
- min(LocalTime) - Method in interface org.instancio.generator.specs.LocalTimeSpec
-
Specifies the lower bound.
- min(MonthDay) - Method in interface org.instancio.generator.specs.MonthDayGeneratorSpec
-
Generate a
MonthDayvalue on or after the specified day. - min(MonthDay) - Method in interface org.instancio.generator.specs.MonthDaySpec
-
Generate a
MonthDayvalue on or after the specified day. - min(OffsetDateTime) - Method in interface org.instancio.generator.specs.OffsetDateTimeGeneratorSpec
-
Specifies the lower bound.
- min(OffsetDateTime) - Method in interface org.instancio.generator.specs.OffsetDateTimeSpec
-
Specifies the lower bound.
- min(OffsetTime) - Method in interface org.instancio.generator.specs.OffsetTimeGeneratorSpec
-
Specifies the lower bound.
- min(OffsetTime) - Method in interface org.instancio.generator.specs.OffsetTimeSpec
-
Specifies the lower bound.
- min(Year) - Method in interface org.instancio.generator.specs.YearSpec
-
Specifies the lower bound.
- min(YearMonth) - Method in interface org.instancio.generator.specs.YearMonthSpec
-
Specifies the lower bound.
- min(ZonedDateTime) - Method in interface org.instancio.generator.specs.ZonedDateTimeGeneratorSpec
-
Specifies the lower bound.
- min(ZonedDateTime) - Method in interface org.instancio.generator.specs.ZonedDateTimeSpec
-
Specifies the lower bound.
- min(T) - Method in interface org.instancio.generator.specs.NumberGeneratorSpec
-
Specifies the lower bound.
- min(T) - Method in interface org.instancio.generator.specs.NumberSpec
- min(T) - Method in interface org.instancio.generator.specs.TemporalGeneratorSpec
-
Specifies the lower bound.
- min(T) - Method in interface org.instancio.generator.specs.TemporalSpec
-
Specifies the lower bound.
- minLength(int) - Method in interface org.instancio.generator.specs.ArrayGeneratorSpec
-
Minimum length of array to generate.
- minLength(int) - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Specifies the minimum length of the string to generate as returned by
String.length(), or the number of code points when generating aStringGeneratorSpec.unicode(UnicodeBlock...)string. - minLength(int) - Method in interface org.instancio.generator.specs.StringSpec
- minSize(int) - Method in interface org.instancio.generator.specs.CollectionGeneratorSpec
-
Minimum size of collection to generate.
- minSize(int) - Method in interface org.instancio.generator.specs.EnumSetGeneratorSpec
-
Minimum size of
EnumSetto generate. - minSize(int) - Method in interface org.instancio.generator.specs.MapGeneratorSpec
-
Minimum size of map to generate.
- minSize(int) - Method in interface org.instancio.generator.specs.SizeGeneratorSpec
-
The minimum size of the object to generate.
- MIXED - Enum constant in enum org.instancio.settings.StringCase
-
Represents mixed-case strings
[A-Z]. - mixedCase() - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Generates a string that consists of characters
[A-Za-z]. - mixedCase() - Method in interface org.instancio.generator.specs.StringSpec
- mixedCaseAlphabetic(int) - Method in interface org.instancio.Random
-
Generates a random mixed case String comprised of
[a-z, A-Z]. - mod10() - Method in interface org.instancio.generators.ChecksumGenerators
-
Generates numbers that pass the Mod10 checksum algorithm.
- mod10() - Method in interface org.instancio.generators.ChecksumSpecs
-
Generates numbers that pass the Mod10 checksum algorithm.
- Mod10GeneratorSpec - Interface in org.instancio.generator.specs
-
A spec for generating numbers that pass the Mod10 checksum algorithm.
- Mod10Spec - Interface in org.instancio.generator.specs
-
A spec for generating numbers that pass the Mod10 checksum algorithm.
- mod11() - Method in interface org.instancio.generators.ChecksumGenerators
-
Generates numbers that pass the Mod11 checksum algorithm.
- mod11() - Method in interface org.instancio.generators.ChecksumSpecs
-
Generates numbers that pass the Mod11 checksum algorithm.
- Mod11GeneratorSpec - Interface in org.instancio.generator.specs
-
A spec for generating numbers that pass the Mod11 checksum algorithm.
- Mod11Spec - Interface in org.instancio.generator.specs
-
A spec for generating numbers that pass the Mod11 checksum algorithm.
- Mode - Enum in org.instancio.settings
-
The mode is used to specify strictness level, either
Mode.STRICTorMode.LENIENT, an idea borrowed from the Mockito library. - MODE - Static variable in class org.instancio.settings.Keys
-
Specifies the mode: strict (unused selectors will trigger an exception) or lenient; default is
Mode.STRICT; property namemode. - Model<T> - Interface in org.instancio
-
A model is a template for creating objects and contains all the parameters for populating a class specified using Instancio API.
- monthDay() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises generated
MonthDayvalues. - monthDay() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises generated
MonthDayvalues. - MonthDayGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for
MonthDaytypes. - MonthDaySpec - Interface in org.instancio.generator.specs
-
Generator spec for
MonthDaytypes. - months(int, int) - Method in interface org.instancio.generator.specs.PeriodGeneratorSpec
-
Generate number of
Periodmonths in the given range. - months(int, int) - Method in interface org.instancio.generator.specs.PeriodSpec
-
Generate number of
Periodmonths in the given range. - multiplier(int) - Method in interface org.instancio.generator.specs.Mod10GeneratorSpec
-
Multiplier to be used for odd digits when calculating the Mod10 checksum (default value is
3). - multiplier(int) - Method in interface org.instancio.generator.specs.Mod10Spec
N
- name(Generator<String>) - Method in interface org.instancio.generator.specs.FilePathSpec
- name(Generator<String>) - Method in interface org.instancio.generator.specs.FileSpec
- name(Generator<String>) - Method in interface org.instancio.generator.specs.PathGeneratorSpec
-
Generator for the file or directory name.
- name(Generator<String>) - Method in interface org.instancio.generator.specs.PathSpec
- named(String) - Method in interface org.instancio.FieldSelectorBuilder
-
Matches fields with the specified name.
- net() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Provides generators for
java.netclasses. - net() - Method in interface org.instancio.generators.Generators
-
Provides generators for
java.netclasses. - net() - Method in interface org.instancio.generators.ValueSpecs
-
Provides generators for
java.netclasses. - NetGenerators - Interface in org.instancio.generators
-
Contains built-in generators for
java.netclasses. - NetSpecs - Interface in org.instancio.generators
-
Provides generators for
java.netclasses. - next(UnaryOperator<T>) - Method in interface org.instancio.generator.specs.NumericSequenceGeneratorSpec
-
Specifies the function for calculating the next sequence value.
- next(UnaryOperator<T>) - Method in interface org.instancio.generator.specs.NumericSequenceSpec
- nextEnd(RandomUnaryOperator<T>) - Method in interface org.instancio.generator.specs.IntervalSpec
-
Specifies the function for calculating the
endvalue of the interval based on thestartvalue of the current interval. - nextStart(RandomUnaryOperator<T>) - Method in interface org.instancio.generator.specs.IntervalSpec
-
Specifies the function for calculating the
startvalue of the next interval based on theendvalue of the current interval. - nio() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Provides access to NIO generators.
- nio() - Method in interface org.instancio.generators.Generators
-
Provides access to NIO generators.
- nio() - Method in interface org.instancio.generators.ValueSpecs
-
Provides access to NIO generators.
- NioGenerators - Interface in org.instancio.generators
-
Contains built-in generators for
java.nioclasses. - NioSpecs - Interface in org.instancio.generators
-
Provides generators for
java.nioclasses. - nip() - Method in interface org.instancio.generators.pol.PolIdGenerators
-
Generates Polish VAT Identification Number (NIP).
- nip() - Method in interface org.instancio.generators.pol.PolIdSpecs
-
Generates Polish VAT Identification Number (NIP).
- NipGeneratorSpec - Interface in org.instancio.generator.specs.pol
-
Spec for generating Polish VAT Identification Number (NIP).
- NipSpec - Interface in org.instancio.generator.specs.pol
-
Spec for generating Polish VAT Identification Number (NIP).
- Node - Interface in org.instancio
-
Represents a single
Nodeof a node hierarchy created for a givenType. - noHeader() - Method in interface org.instancio.generator.specs.CsvGeneratorSpec
-
Omit CSV header from the output.
- noHeader() - Method in interface org.instancio.generator.specs.CsvSpec
-
Omit CSV header from the output.
- NonDeterministic - Annotation Type in org.instancio.documentation
-
This annotation marks APIs that produce data which cannot be guaranteed to be reproducible.
- NONE - Enum constant in enum org.instancio.settings.FeedDataTrim
-
No trimming is performed on the data.
- nullable() - Method in interface org.instancio.generator.specs.ArrayGeneratorSpec
-
Indicates that
nullvalue can be generated for the array. - nullable() - Method in interface org.instancio.generator.specs.BigDecimalGeneratorSpec
- nullable() - Method in interface org.instancio.generator.specs.BigDecimalSpec
- nullable() - Method in interface org.instancio.generator.specs.BigIntegerSpec
- nullable() - Method in interface org.instancio.generator.specs.BooleanGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.BooleanSpec
- nullable() - Method in interface org.instancio.generator.specs.bra.CnpjGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.bra.CnpjSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.bra.CpfGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.bra.CpfSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.bra.TituloEleitoralGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.bra.TituloEleitoralSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.ByteSpec
- nullable() - Method in interface org.instancio.generator.specs.can.SinGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.can.SinSpec
- nullable() - Method in interface org.instancio.generator.specs.CharacterGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.CharacterSpec
- nullable() - Method in interface org.instancio.generator.specs.CollectionGeneratorSpec
-
Indicates that
nullvalue can be generated for the collection. - nullable() - Method in interface org.instancio.generator.specs.CoordinateGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.CoordinateSpec
- nullable() - Method in interface org.instancio.generator.specs.CreditCardGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.CreditCardSpec
- nullable() - Method in interface org.instancio.generator.specs.DoubleSpec
- nullable() - Method in interface org.instancio.generator.specs.DurationGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.DurationSpec
- nullable() - Method in interface org.instancio.generator.specs.EanGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.EanSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.EmailGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.EmailSpec
- nullable() - Method in interface org.instancio.generator.specs.EnumGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.EnumSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.FloatSpec
- nullable() - Method in interface org.instancio.generator.specs.HashGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.HashSpec
- nullable() - Method in interface org.instancio.generator.specs.InstantGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.InstantSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.IntegerSpec
- nullable() - Method in interface org.instancio.generator.specs.IntervalSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.IsbnGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.IsbnSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.LocalDateSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.LocalDateTimeGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.LocalDateTimeSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.LocalTimeGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.LocalTimeSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.LongSpec
- nullable() - Method in interface org.instancio.generator.specs.LoremIpsumSpec
- nullable() - Method in interface org.instancio.generator.specs.LuhnGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.LuhnSpec
- nullable() - Method in interface org.instancio.generator.specs.MapGeneratorSpec
-
Indicates that
nullvalue can be generated for the map. - nullable() - Method in interface org.instancio.generator.specs.Mod10GeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.Mod10Spec
- nullable() - Method in interface org.instancio.generator.specs.Mod11GeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.Mod11Spec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.MonthDaySpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.NullableGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.NumberGeneratorSpec
-
Specifies that a
nullcan be generated. - nullable() - Method in interface org.instancio.generator.specs.NumberSpec
- nullable() - Method in interface org.instancio.generator.specs.NumericSequenceGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.NumericSequenceSpec
- nullable() - Method in interface org.instancio.generator.specs.OffsetDateTimeGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.OffsetDateTimeSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.OffsetTimeGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.OffsetTimeSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.pol.NipGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.pol.NipSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.pol.PeselGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.pol.PeselSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.pol.RegonGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.pol.RegonSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.rus.InnGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.rus.InnSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.ShortSpec
- nullable() - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.StringSpec
- nullable() - Method in interface org.instancio.generator.specs.TemporalGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.TemporalSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.TextPatternGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.TextPatternSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.URIGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.URISpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.URLGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.URLSpec
- nullable() - Method in interface org.instancio.generator.specs.usa.SsnGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.usa.SsnSpec
- nullable() - Method in interface org.instancio.generator.specs.UUIDSpec
- nullable() - Method in interface org.instancio.generator.specs.UUIDStringGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.UUIDStringSpec
- nullable() - Method in interface org.instancio.generator.specs.YearMonthSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.YearSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.specs.ZonedDateTimeGeneratorSpec
-
Indicates that
nullvalue can be generated. - nullable() - Method in interface org.instancio.generator.specs.ZonedDateTimeSpec
-
Specifies that a
nullvalue can be generated - nullable() - Method in interface org.instancio.generator.ValueSpec
-
Specifies that a
nullvalue can be generated - nullableElements() - Method in class org.instancio.generator.hints.ArrayHint
-
Indicates whether elements can be
null. - nullableElements() - Method in class org.instancio.generator.hints.CollectionHint
-
Indicates whether elements can be
null. - nullableElements() - Method in interface org.instancio.generator.specs.ArrayGeneratorSpec
-
Indicates that
nullvalues can be generated for array elements. - nullableElements() - Method in interface org.instancio.generator.specs.CollectionGeneratorSpec
-
Indicates that
nullvalues can be generated for collection elements. - nullableElements(boolean) - Method in class org.instancio.generator.hints.ArrayHint.Builder
-
Indicates whether
nullelements are allowed to be generated. - nullableElements(boolean) - Method in class org.instancio.generator.hints.CollectionHint.Builder
-
Indicates whether
nullelements are allowed to be generated. - NullableGeneratorSpec<T> - Interface in org.instancio.generator.specs
-
Provides methods for specifying whether
nullcan be generated. - nullableKeys() - Method in interface org.instancio.generator.specs.MapGeneratorSpec
-
Indicates that
nullvalues can be generated for map keys. - nullableMapKeys() - Method in class org.instancio.generator.hints.MapHint
-
Indicates whether map keys can be
null. - nullableMapKeys(boolean) - Method in class org.instancio.generator.hints.MapHint.Builder
-
Indicates whether
nulls are allowed to be inserted as map keys. - nullableMapValues() - Method in class org.instancio.generator.hints.MapHint
-
Indicates whether map values can be
null. - nullableMapValues(boolean) - Method in class org.instancio.generator.hints.MapHint.Builder
-
Indicates whether
nulls are allowed to be inserted as map values. - nullableValues() - Method in interface org.instancio.generator.specs.MapGeneratorSpec
-
Indicates that
nullvalues can be generated for map values. - NumberGeneratorSpec<T> - Interface in org.instancio.generator.specs
-
Generator spec for numeric types.
- NumberSpec<T> - Interface in org.instancio.generator.specs
-
Spec for generating
Numbertypes. - NUMERIC_SEQUENCE - Enum constant in enum org.instancio.settings.StringType
-
Represents a string sequence that starts from
"1"and increments by one. - numericSequence() - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Generates a string sequence that starts from
"1"and increments by one. - numericSequence() - Method in interface org.instancio.generator.specs.StringSpec
-
Generates a string sequence that starts from
"1"and increments by one. - NumericSequenceGeneratorSpec<T> - Interface in org.instancio.generator.specs
-
A spec for generating numeric sequences.
- NumericSequenceSpec<T> - Interface in org.instancio.generator.specs
-
Spec for generating numeric sequences.
O
- of(long, long, TemporalUnit) - Method in interface org.instancio.generator.specs.DurationGeneratorSpec
-
Generate a
Durationin the given range, measured in specified units. - of(long, long, TemporalUnit) - Method in interface org.instancio.generator.specs.DurationSpec
- of(E...) - Method in interface org.instancio.generator.specs.EnumSetGeneratorSpec
-
Specifies choices from which the
EnumSetwill be generated. - of(Class<?>) - Method in interface org.instancio.TypeSelectorBuilder
-
Matches specified type, including subtypes.
- of(Class<F>) - Method in interface org.instancio.feed.FeedProvider.FeedBuilderFactory
-
Creates a feed instance of the specified feed class.
- of(Class<T>) - Static method in class org.instancio.Instancio
-
Builder version of
Instancio.create(Class)that allows customisation of generated values. - of(Model<T>) - Static method in class org.instancio.Instancio
-
Builder version of
Instancio.create(Model)that allows overriding of generation parameters of an existing model. - of(TypeTokenSupplier<T>) - Static method in class org.instancio.Instancio
-
Builder version of
Instancio.create(TypeTokenSupplier)that allows customisation of generated values. - ofBlank(Class<T>) - Static method in class org.instancio.Instancio
-
Builder version of the
Instancio.createBlank(Class)method that allows customisation of generated values. - ofCartesianProduct(Class<T>) - Static method in class org.instancio.Instancio
-
Generates the Cartesian product based on the values specified via the
with()method. - ofCartesianProduct(Model<T>) - Static method in class org.instancio.Instancio
-
Generates the Cartesian product based on the values specified via the
with()method. - ofCartesianProduct(TypeTokenSupplier<T>) - Static method in class org.instancio.Instancio
-
Generates the Cartesian product based on the values specified via the
with()method. - ofFeed(Class<F>) - Static method in class org.instancio.Instancio
-
Builder version of
Instancio.createFeed(Class)that allows customising the feed's properties. - ofFile(Path) - Method in interface org.instancio.feed.DataSourceProvider.DataSourceFactory
-
Creates a data source for the given
path. - ofFile(Path) - Method in interface org.instancio.feed.FeedProvider.FeedBuilderFactory
-
Creates a feed instance for the specified file path.
- offsetDateTime() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises generated
OffsetDateTimevalues. - offsetDateTime() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises generated
OffsetDateTimevalues. - OffsetDateTimeGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for
OffsetDateTime. - offsetDateTimeSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns an
offsetDateTimespec for the given property name. - OffsetDateTimeSpec - Interface in org.instancio.generator.specs
-
Spec for generating
OffsetDateTimevalues. - offsetTime() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises generated
OffsetTimevalues. - offsetTime() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises generated
OffsetTimevalues. - OffsetTimeGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for
OffsetTime. - offsetTimeSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns an
OffsetTimespec for the given property name. - OffsetTimeSpec - Interface in org.instancio.generator.specs
-
Spec for generating
OffsetTimevalues. - ofInputStream(InputStream) - Method in interface org.instancio.feed.DataSourceProvider.DataSourceFactory
-
Creates a data source for the given
inputStream. - ofInputStream(InputStream) - Method in interface org.instancio.feed.FeedProvider.FeedBuilderFactory
-
Creates a feed instance for the specified input stream.
- ofList(Class<T>) - Static method in class org.instancio.Instancio
-
Builder API for generating a
Listthat allows customising generated values. - ofList(Model<T>) - Static method in class org.instancio.Instancio
-
Builder API for generating a
Listusing the specified model for list elements. - ofList(TypeTokenSupplier<T>) - Static method in class org.instancio.Instancio
-
Builder API for generating a
Listusing a type token. - ofMap(Class<K>, Class<V>) - Static method in class org.instancio.Instancio
-
Builder API for generating a
Mapthat allowss customisation of generated values. - ofMap(TypeTokenSupplier<K>, TypeTokenSupplier<V>) - Static method in class org.instancio.Instancio
-
Builder API for generating a
Mapusing type tokens. - ofResource(String) - Method in interface org.instancio.feed.DataSourceProvider.DataSourceFactory
-
Creates a data source for the given resource
name. - ofResource(String) - Method in interface org.instancio.feed.FeedProvider.FeedBuilderFactory
-
Creates a feed instance for the specified classpath resource.
- ofSet(Class<T>) - Static method in class org.instancio.Instancio
-
Builder API for generating a
Setthat allows customisation of generated values. - ofSet(Model<T>) - Static method in class org.instancio.Instancio
-
Builder API for generating a
Setusing the specified model for list elements. - ofSet(TypeTokenSupplier<T>) - Static method in class org.instancio.Instancio
-
Builder API for generating a
Setusing a type token. - ofString(String) - Method in interface org.instancio.feed.DataSourceProvider.DataSourceFactory
-
Creates a data source from the given
datastring. - ofString(String) - Method in interface org.instancio.feed.FeedProvider.FeedBuilderFactory
-
Creates a feed instance with the given data.
- ofType(Class<?>) - Method in interface org.instancio.FieldSelectorBuilder
-
Matches fields against the specified type, including subtypes.
- ofType(Class<T>) - Static method in class org.instancio.settings.Keys
-
A builder for creating custom setting keys.
- ofType(Class<T>) - Method in interface org.instancio.settings.SettingKey.SettingKeyBuilder
-
Specifies the value's type.
- ON_SET_FIELD_ERROR - Static variable in class org.instancio.settings.Keys
-
Specifies what should happen if an error occurs setting a field's value; default is
OnSetFieldError.IGNORE; property nameon.set.field.error. - ON_SET_METHOD_ERROR - Static variable in class org.instancio.settings.Keys
-
Specifies what should happen if an error occurs invoking a setter; default is
OnSetMethodError.ASSIGN_FIELD; property nameon.set.method.error. - ON_SET_METHOD_NOT_FOUND - Static variable in class org.instancio.settings.Keys
-
Specifies what should happen if a setter method for a field cannot be resolved; default is
OnSetMethodNotFound.ASSIGN_FIELD; property nameon.set.method.not.found. - ON_SET_METHOD_UNMATCHED - Static variable in class org.instancio.settings.Keys
-
Specifies what should happen if a setter without a matching field is encountered; default is
OnSetMethodUnmatched.IGNORE; property nameon.set.method.unmatched. - onComplete(TargetSelector, OnCompleteCallback<V>) - Method in interface org.instancio.BaseApi
-
A callback that gets invoked after the root object has been fully populated.
- onComplete(TargetSelector, OnCompleteCallback<V>) - Method in interface org.instancio.InstancioApi
-
A callback that gets invoked after the root object has been fully populated.
- onComplete(TargetSelector, OnCompleteCallback<V>) - Method in interface org.instancio.InstancioCartesianProductApi
-
A callback that gets invoked after the root object has been fully populated.
- onComplete(T) - Method in interface org.instancio.OnCompleteCallback
-
A callback method that is called after an object has been populated.
- OnCompleteCallback<T> - Interface in org.instancio
-
A callback that gets invoked after an object has been fully populated.
- onDataEnd(FeedDataEndAction) - Method in interface org.instancio.FeedApi
-
Specifies the action to take when the end of the data feed is reached.
- onDataEnd(FeedDataEndAction) - Method in interface org.instancio.InstancioFeedApi
-
Specifies the action to take when the end of the data feed is reached.
- oneOf(Collection<T>) - Method in interface org.instancio.generator.specs.OneOfCollectionGeneratorSpec
-
Selects a random value from the given choices.
- oneOf(Collection<T>) - Method in interface org.instancio.generator.specs.OneOfCollectionSpec
- oneOf(Collection<T>) - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Picks a random value from the given choices.
- oneOf(Collection<T>) - Method in interface org.instancio.generators.Generators
-
Picks a random value from the given choices.
- oneOf(Collection<T>) - Method in interface org.instancio.generators.ValueSpecs
-
Picks a random value from the given choices.
- oneOf(Collection<T>) - Method in interface org.instancio.Random
-
Returns a random element from the given collection.
- oneOf(T...) - Method in interface org.instancio.generator.specs.OneOfArrayGeneratorSpec
-
Selects a random value from the given choices.
- oneOf(T...) - Method in interface org.instancio.generator.specs.OneOfArraySpec
- oneOf(T...) - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Picks a random value from the given choices.
- oneOf(T...) - Method in interface org.instancio.generators.Generators
-
Picks a random value from the given choices.
- oneOf(T...) - Method in interface org.instancio.generators.ValueSpecs
-
Picks a random value from the given choices.
- oneOf(T...) - Method in interface org.instancio.Random
-
Returns a random element from the given array.
- OneOfArrayGeneratorSpec<T> - Interface in org.instancio.generator.specs
-
Generator spec for selecting a random value from an array.
- OneOfArraySpec<T> - Interface in org.instancio.generator.specs
-
Spec for selecting a random value from an array.
- OneOfCollectionGeneratorSpec<T> - Interface in org.instancio.generator.specs
-
Generator spec for selecting a random value from collection.
- OneOfCollectionSpec<T> - Interface in org.instancio.generator.specs
-
Spec for selecting a random value from a collection.
- OnSetFieldError - Enum in org.instancio.settings
-
A setting that specifies what should happen if an error occurs when setting a field's value.
- OnSetMethodError - Enum in org.instancio.settings
-
A setting that specifies what should happen if an error occurs during a setter method invocation.
- OnSetMethodNotFound - Enum in org.instancio.settings
-
A setting that specifies what should happen if a setter cannot be resolved.
- OnSetMethodUnmatched - Enum in org.instancio.settings
-
A setting that specifies what should happen if a setter has no matching field.
- Option 1: using a TypeToken - Search tag in class org.instancio.Instancio
- Section
- Option 2: using withTypeParameters to specify the type arguments - Search tag in class org.instancio.Instancio
- Section
- optional() - Method in interface org.instancio.generators.Generators
-
Generator for
Optional. - OptionalGeneratorSpec<T> - Interface in org.instancio.generator.specs
-
Generator spec for
Optional. - org.instancio - package org.instancio
-
Instancio public-facing APIs; for usage examples see
Instancio. - org.instancio.documentation - package org.instancio.documentation
-
API documentation classes.
- org.instancio.exception - package org.instancio.exception
-
Contains exception classes thrown by Instancio.
- org.instancio.feed - package org.instancio.feed
-
Contains classes related to
Feed. - org.instancio.generator - package org.instancio.generator
-
Contains classes related to generators.
- org.instancio.generator.hints - package org.instancio.generator.hints
-
Contains
Hintimplementations. - org.instancio.generator.specs - package org.instancio.generator.specs
-
Defines generator specs.
- org.instancio.generator.specs.bra - package org.instancio.generator.specs.bra
-
Defines generator specs for Brazilian identifiers.
- org.instancio.generator.specs.can - package org.instancio.generator.specs.can
-
Defines generator specs for Canada.
- org.instancio.generator.specs.pol - package org.instancio.generator.specs.pol
-
Defines generator specs for Poland.
- org.instancio.generator.specs.rus - package org.instancio.generator.specs.rus
-
Defines generator specs for Russian identifiers.
- org.instancio.generator.specs.usa - package org.instancio.generator.specs.usa
-
Defines generator specs for USA.
- org.instancio.generators - package org.instancio.generators
-
Defines classes that provide access to built-in generators.
- org.instancio.generators.bra - package org.instancio.generators.bra
-
Defines classes that provide access to built-in generators specific to Brazil.
- org.instancio.generators.can - package org.instancio.generators.can
-
Defines classes that provide access to built-in generators specific to Canada.
- org.instancio.generators.pol - package org.instancio.generators.pol
-
Defines classes that provide access to built-in generators specific to Poland.
- org.instancio.generators.rus - package org.instancio.generators.rus
-
Defines classes that provide access to built-in generators specific to Russia.
- org.instancio.generators.usa - package org.instancio.generators.usa
-
Defines classes that provide access to built-in generators specific to the USA.
- org.instancio.settings - package org.instancio.settings
-
Provides classes for overriding settings at runtime.
- org.instancio.spi - package org.instancio.spi
-
Defines Service Provider Interfaces for providing custom implementations.
- OVERWRITE_EXISTING_VALUES - Static variable in class org.instancio.settings.Keys
-
Specifies whether initialised fields can be overwritten by the engine to random values; default is
true; property nameoverwrite.existing.values.
P
- 2. Populating values via the generate() method - Search tag in interface org.instancio.feed.Feed
- Section
- PACKAGE_PRIVATE - Static variable in class org.instancio.settings.MethodModifier
-
Modifier for package-private method.
- paragraphs(int) - Method in interface org.instancio.generator.specs.LoremIpsumGeneratorSpec
-
Number of paragraphs to generate.
- paragraphs(int) - Method in interface org.instancio.generator.specs.LoremIpsumSpec
- params() - Element in annotation type org.instancio.feed.FeedSpecAnnotations.FunctionSpec
-
Specifies the names of one or more
FeedSpecmethods declared by a feed. - past() - Method in interface org.instancio.generator.specs.InstantGeneratorSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.InstantSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.LocalDateSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.LocalDateTimeGeneratorSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.LocalDateTimeSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.LocalTimeGeneratorSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.LocalTimeSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.OffsetDateTimeGeneratorSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.OffsetDateTimeSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.OffsetTimeGeneratorSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.OffsetTimeSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.TemporalGeneratorSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.TemporalSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.YearMonthSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.YearSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.ZonedDateTimeGeneratorSpec
-
Generate a value in the past.
- past() - Method in interface org.instancio.generator.specs.ZonedDateTimeSpec
-
Generate a value in the past.
- path(String...) - Method in interface org.instancio.generators.NioGenerators
-
Generator for
Pathobjects. - path(String...) - Method in interface org.instancio.generators.NioSpecs
-
Generator for
Pathobjects. - path(Generator<String>) - Method in interface org.instancio.generator.specs.URIGeneratorSpec
-
Specifies a generator for the path.
- path(Generator<String>) - Method in interface org.instancio.generator.specs.URISpec
-
Specifies a generator for the path.
- PathGeneratorSpec<T> - Interface in org.instancio.generator.specs
- PathSpec - Interface in org.instancio.generator.specs
-
Spec for generating
Pathvalues. - pattern(String) - Method in interface org.instancio.generators.TextGenerators
-
Generates a random string based on the specified pattern template.
- pattern(String) - Method in interface org.instancio.generators.TextSpecs
-
Generates a random string based on the specified pattern template.
- period() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises returned
Periodvalues. - period() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises returned
Periodvalues. - PeriodGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for
Period. - PeriodSpec - Interface in org.instancio.generator.specs
-
Spec for generating
Period. - permanent() - Method in interface org.instancio.generator.specs.can.SinGeneratorSpec
-
Generates a permanent card number with the first digit
1-7, inclusive. - permanent() - Method in interface org.instancio.generator.specs.can.SinSpec
- pesel() - Method in interface org.instancio.generators.pol.PolIdGenerators
-
Generates Polish National Identification Number (PESEL).
- pesel() - Method in interface org.instancio.generators.pol.PolIdSpecs
-
Generates Polish National Identification Number (PESEL).
- PeselGeneratorSpec - Interface in org.instancio.generator.specs.pol
-
Spec for generating Polish National Identification Number (PESEL).
- PeselSpec - Interface in org.instancio.generator.specs.pol
-
Spec for generating Polish National Identification Number (PESEL).
- pol() - Method in interface org.instancio.generators.IdGenerators
-
Provides access to identifier generators for Poland.
- pol() - Method in interface org.instancio.generators.IdSpecs
-
Provides access to identifier generators for Poland.
- PolIdGenerators - Interface in org.instancio.generators.pol
-
Contains built-in generators for Polish identifiers.
- PolIdSpecs - Interface in org.instancio.generators.pol
-
Provides generators for Polish identifiers.
- POPULATE_ALL - Enum constant in enum org.instancio.generator.AfterGenerate
-
Indicates that all fields should be populated, regardless of their initial values.
- POPULATE_NULLS - Enum constant in enum org.instancio.generator.AfterGenerate
-
Indicates that any
nullfields in an object created by the generator should be populated by the engine. - POPULATE_NULLS_AND_DEFAULT_PRIMITIVES - Enum constant in enum org.instancio.generator.AfterGenerate
-
Indicates that primitive fields with default values in an object created by the generator should be populated by the engine.
- port(int) - Method in interface org.instancio.generator.specs.URIGeneratorSpec
-
Specifies the port number.
- port(int) - Method in interface org.instancio.generator.specs.URISpec
-
Specifies the port number.
- port(int) - Method in interface org.instancio.generator.specs.URLGeneratorSpec
-
Specifies the port number.
- port(int) - Method in interface org.instancio.generator.specs.URLSpec
- PostProcessor<T> - Interface in org.instancio.feed
-
An interface for applying additional processing to data returned by a spec method of a
Feed. - Precedence - Search tag in org.instancio.BaseApi.ignore(TargetSelector)
- Section
- Precedence - Search tag in org.instancio.BaseApi.ignore(TargetSelector)
- Section
- Precedence - Search tag in org.instancio.BaseApi.ignore(TargetSelector)
- Section
- precision(int) - Method in interface org.instancio.generator.specs.BigDecimalGeneratorSpec
-
Precision of the generated
BigDecimal. - precision(int) - Method in interface org.instancio.generator.specs.BigDecimalSpec
-
Precision of the generated
BigDecimal. - PredicateSelector - Interface in org.instancio
-
A selector for matching targets using predicates.
- prefix(String) - Method in interface org.instancio.generator.specs.FilePathSpec
- prefix(String) - Method in interface org.instancio.generator.specs.FileSpec
- prefix(String) - Method in interface org.instancio.generator.specs.PathGeneratorSpec
-
File or directory name prefix.
- prefix(String) - Method in interface org.instancio.generator.specs.PathSpec
- prefix(String) - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Specifies the prefix to prepend to generated strings.
- prefix(String) - Method in interface org.instancio.generator.specs.StringSpec
- PRIVATE - Static variable in class org.instancio.settings.MethodModifier
-
Modifier for
privatemethod. - probability(double) - Method in interface org.instancio.generator.specs.BooleanGeneratorSpec
-
Specifies the probability of generating
true. - probability(double) - Method in interface org.instancio.generator.specs.BooleanSpec
-
Specifies the probability of generating
true. - process(T, Random) - Method in interface org.instancio.feed.PostProcessor
-
Processes the given
inputvalue. - PROPERTY - Enum constant in enum org.instancio.settings.SetterStyle
-
Setters without a prefix, where the setter's name is the same as the corresponding property name, for example
foo("value") - propertyKey() - Method in interface org.instancio.settings.SettingKey
-
A unique property key identifying this setting.
- PROTECTED - Static variable in class org.instancio.settings.MethodModifier
-
Modifier for
protectedmethod. - protocol(String...) - Method in interface org.instancio.generator.specs.URLGeneratorSpec
-
Generate a random protocol from the given choices.
- protocol(String...) - Method in interface org.instancio.generator.specs.URLSpec
- Provide a partially initialised instance - Search tag in org.instancio.BaseApi.supply(TargetSelector, Generator<V>)
- Section
- Provide a partially initialised instance - Search tag in org.instancio.BaseApi.supply(TargetSelector, Generator<V>)
- Section
- Provide a partially initialised instance - Search tag in org.instancio.BaseApi.supply(TargetSelector, Generator<V>)
- Section
- provider() - Element in annotation type org.instancio.feed.FeedSpecAnnotations.FunctionSpec
-
A class containing the method for handling this function spec.
- PUBLIC - Static variable in class org.instancio.settings.MethodModifier
-
Modifier for
publicmethod.
Q
- query(Generator<String>) - Method in interface org.instancio.generator.specs.URIGeneratorSpec
-
Specifies a generator for the query.
- query(Generator<String>) - Method in interface org.instancio.generator.specs.URISpec
-
Specifies a generator for the query.
R
- random() - Method in class org.instancio.generator.GeneratorContext
-
Returns the random instance used by Instancio to generate data.
- random() - Method in interface org.instancio.spi.ServiceProviderContext
-
Returns the random instance that should be used for generating values to ensure reproducible results.
- Random - Interface in org.instancio
-
Provides methods for generating random values such as numbers, booleans, characters, and strings.
- RANDOM - Enum constant in enum org.instancio.settings.FeedDataAccess
-
Specifies that data should be accessed in random order.
- RandomFunction<T,
R> - Interface in org.instancio -
A function that accepts an argument and produces a randomised result.
- randomPort() - Method in interface org.instancio.generator.specs.URIGeneratorSpec
-
Specifies that a random port number between 1 and 65535 (inclusive) should be generated.
- randomPort() - Method in interface org.instancio.generator.specs.URISpec
-
Specifies that a random port number between 1 and 65535 (inclusive) should be generated.
- randomPort() - Method in interface org.instancio.generator.specs.URLGeneratorSpec
-
Specifies that a random port number between 1 and 65535 (inclusive) should be generated.
- randomPort() - Method in interface org.instancio.generator.specs.URLSpec
- RandomUnaryOperator<T> - Interface in org.instancio
-
Represents a unary operator that produces a result of the same type as its operand.
- range(char, char) - Method in interface org.instancio.generator.specs.CharacterGeneratorSpec
-
Range of characters to generate.
- range(char, char) - Method in interface org.instancio.generator.specs.CharacterSpec
- range(Byte, Byte) - Method in interface org.instancio.generator.specs.ByteSpec
- range(Double, Double) - Method in interface org.instancio.generator.specs.DoubleSpec
- range(Float, Float) - Method in interface org.instancio.generator.specs.FloatSpec
- range(Integer, Integer) - Method in interface org.instancio.generator.specs.IntegerSpec
- range(Long, Long) - Method in interface org.instancio.generator.specs.LongSpec
- range(Short, Short) - Method in interface org.instancio.generator.specs.ShortSpec
- range(BigDecimal, BigDecimal) - Method in interface org.instancio.generator.specs.BigDecimalGeneratorSpec
-
Specifies the range for generated numbers.
- range(BigDecimal, BigDecimal) - Method in interface org.instancio.generator.specs.BigDecimalSpec
-
Specifies the range for generated numbers.
- range(BigInteger, BigInteger) - Method in interface org.instancio.generator.specs.BigIntegerSpec
- range(Instant, Instant) - Method in interface org.instancio.generator.specs.InstantGeneratorSpec
-
Generate a value within the given range.
- range(Instant, Instant) - Method in interface org.instancio.generator.specs.InstantSpec
-
Generate a value within the given range.
- range(LocalDate, LocalDate) - Method in interface org.instancio.generator.specs.LocalDateSpec
-
Generate a value within the given range.
- range(LocalDateTime, LocalDateTime) - Method in interface org.instancio.generator.specs.LocalDateTimeGeneratorSpec
-
Generate a value within the given range.
- range(LocalDateTime, LocalDateTime) - Method in interface org.instancio.generator.specs.LocalDateTimeSpec
-
Generate a value within the given range.
- range(LocalTime, LocalTime) - Method in interface org.instancio.generator.specs.LocalTimeGeneratorSpec
-
Generate a value within the given range.
- range(LocalTime, LocalTime) - Method in interface org.instancio.generator.specs.LocalTimeSpec
-
Generate a value within the given range.
- range(MonthDay, MonthDay) - Method in interface org.instancio.generator.specs.MonthDayGeneratorSpec
-
Generate a
MonthDayvalue between the given range. - range(MonthDay, MonthDay) - Method in interface org.instancio.generator.specs.MonthDaySpec
-
Generate a
MonthDayvalue between the given range. - range(OffsetDateTime, OffsetDateTime) - Method in interface org.instancio.generator.specs.OffsetDateTimeGeneratorSpec
-
Generate a value within the given range.
- range(OffsetDateTime, OffsetDateTime) - Method in interface org.instancio.generator.specs.OffsetDateTimeSpec
-
Generate a value within the given range.
- range(OffsetTime, OffsetTime) - Method in interface org.instancio.generator.specs.OffsetTimeGeneratorSpec
-
Generate a value within the given range.
- range(OffsetTime, OffsetTime) - Method in interface org.instancio.generator.specs.OffsetTimeSpec
-
Generate a value within the given range.
- range(YearMonth, YearMonth) - Method in interface org.instancio.generator.specs.YearMonthSpec
-
Generate a value within the given range.
- range(Year, Year) - Method in interface org.instancio.generator.specs.YearSpec
-
Generate a value within the given range.
- range(ZonedDateTime, ZonedDateTime) - Method in interface org.instancio.generator.specs.ZonedDateTimeGeneratorSpec
-
Generate a value within the given range.
- range(ZonedDateTime, ZonedDateTime) - Method in interface org.instancio.generator.specs.ZonedDateTimeSpec
-
Generate a value within the given range.
- range(T, T) - Method in interface org.instancio.generator.specs.NumberGeneratorSpec
-
Specifies the range for generated numbers.
- range(T, T) - Method in interface org.instancio.generator.specs.NumberSpec
- range(T, T) - Method in interface org.instancio.generator.specs.TemporalGeneratorSpec
-
Generate a value within the given range.
- range(T, T) - Method in interface org.instancio.generator.specs.TemporalSpec
-
Generate a value within the given range.
- RECYCLE - Enum constant in enum org.instancio.settings.FeedDataEndAction
-
Recycles data when exhausted (starting from the beginning).
- regon() - Method in interface org.instancio.generators.pol.PolIdGenerators
-
Generates Polish Taxpayer Identification Number (REGON).
- regon() - Method in interface org.instancio.generators.pol.PolIdSpecs
-
Generates Polish Taxpayer Identification Number (REGON).
- RegonGeneratorSpec - Interface in org.instancio.generator.specs.pol
-
Spec for generating Polish Taxpayer Identification Number (REGON).
- RegonSpec - Interface in org.instancio.generator.specs.pol
-
Spec for generating Polish Taxpayer Identification Number (REGON).
- resource() - Element in annotation type org.instancio.feed.Feed.Source
-
Specifies the name of a classpath resource containing the data for a feed.
- Result<T> - Interface in org.instancio
-
A result containing a created object and seed that was used for populating its values.
- root() - Static method in class org.instancio.Select
-
Selects the root object.
- rows(int) - Method in interface org.instancio.generator.specs.CsvGeneratorSpec
-
Number of rows to generate.
- rows(int) - Method in interface org.instancio.generator.specs.CsvSpec
-
Number of rows to generate.
- rows(int, int) - Method in interface org.instancio.generator.specs.CsvGeneratorSpec
-
A range for the number of rows to generate.
- rows(int, int) - Method in interface org.instancio.generator.specs.CsvSpec
-
A range for the number of rows to generate.
- rus() - Method in interface org.instancio.generators.IdGenerators
-
Provides access to identifier generators for Russia.
- rus() - Method in interface org.instancio.generators.IdSpecs
-
Provides access to identifier generators for Russia.
- RusIdGenerators - Interface in org.instancio.generators.rus
-
Contains built-in generators for Russian identifiers.
- RusIdSpecs - Interface in org.instancio.generators.rus
-
Provides generators for Russian identifiers.
S
- satisfies(Predicate<T>) - Method in interface org.instancio.GivenOrigin
-
Checks if the origin value matched satisfies given
predicate. - scale(int) - Method in interface org.instancio.generator.specs.BigDecimalGeneratorSpec
-
Scale of the generated
BigDecimal. - scale(int) - Method in interface org.instancio.generator.specs.BigDecimalSpec
- scheme(String...) - Method in interface org.instancio.generator.specs.URIGeneratorSpec
-
Generate a random scheme from the given choices.
- scheme(String...) - Method in interface org.instancio.generator.specs.URISpec
-
Generate a random scheme from the given choices.
- scope(Class<?>) - Static method in class org.instancio.Select
-
Creates a selector scope for narrowing down a selector's target to the specified class.
- scope(Class<?>, String) - Static method in class org.instancio.Select
-
Creates a scope for narrowing down a selector's target to a field of the specified class.
- scope(GetMethodSelector<T, R>) - Static method in class org.instancio.Select
-
Creates a scope for narrowing down a selector's target to a matching the specified method reference.
- scope(PredicateSelector) - Static method in class org.instancio.Select
-
Creates a scope from the given predicate selector.
- Scope - Interface in org.instancio
-
A scope for narrowing down selector targets.
- ScopeableSelector - Interface in org.instancio
-
Represents a selector that can be scoped using
within(Scope...scopes). - SEED - Static variable in class org.instancio.settings.Keys
-
Specifies the seed value; default is
null; property nameseed. - Select - Class in org.instancio
-
Provides static factory methods for creating selectors and selector scopes.
- Selector - Interface in org.instancio
-
Represents regular field and class selectors, including primitive and wrapper selectors.
- SelectorGroup - Interface in org.instancio
-
A marker for selectors that contain other selectors.
- separator(String) - Method in interface org.instancio.generator.specs.can.SinGeneratorSpec
-
Separator for groups of three digits.
- separator(String) - Method in interface org.instancio.generator.specs.can.SinSpec
- separator(String) - Method in interface org.instancio.generator.specs.usa.SsnGeneratorSpec
-
Generates an SSN formatted with the given separator.
- separator(String) - Method in interface org.instancio.generator.specs.usa.SsnSpec
- SEQUENTIAL - Enum constant in enum org.instancio.settings.FeedDataAccess
-
Specifies that data should be accessed in sequential order.
- ServiceProviderContext - Interface in org.instancio.spi
-
Provides additional information to
InstancioServiceProvider. - set(Predicate<S>, T) - Method in interface org.instancio.GivenOriginDestination
-
Sets a value to matching selector targets.
- set(SettingKey<T>, T) - Method in interface org.instancio.settings.Settings
-
Set the setting with the given key to the specified value.
- set(TargetSelector, T) - Method in interface org.instancio.GivenOriginPredicate
-
Sets a value to matching selector targets.
- set(TargetSelector, V) - Method in interface org.instancio.BaseApi
-
Sets a value to matching selector targets.
- set(TargetSelector, V) - Method in interface org.instancio.InstancioApi
-
Sets a value to matching selector targets.
- set(TargetSelector, V) - Method in interface org.instancio.InstancioCartesianProductApi
-
Sets a value to matching selector targets.
- set(T) - Method in interface org.instancio.ValueOf
-
Sets a value to matching selector targets.
- SET - Enum constant in enum org.instancio.settings.SetterStyle
-
Standard setters with "set" prefix, for example
setFoo("value") - SET_BACK_REFERENCES - Static variable in class org.instancio.settings.Keys
-
Specifies whether back references should be set for cyclic classes; default is
false(cycles are terminated withnull); property nameset.back.references. - setBlank(TargetSelector) - Method in interface org.instancio.BaseApi
-
Specifies that a blank object should be generated for the selected target.
- setBlank(TargetSelector) - Method in interface org.instancio.InstancioApi
-
Specifies that a blank object should be generated for the selected target.
- setBlank(TargetSelector) - Method in interface org.instancio.InstancioCartesianProductApi
-
Specifies that a blank object should be generated for the selected target.
- SetMethodSelector<T,
U> - Interface in org.instancio -
A selector for setter methods.
- setModel(TargetSelector, Model<V>) - Method in interface org.instancio.BaseApi
-
Applies given
modelto the specifiedselector. - setModel(TargetSelector, Model<V>) - Method in interface org.instancio.InstancioApi
-
Applies given
modelto the specifiedselector. - setModel(TargetSelector, Model<V>) - Method in interface org.instancio.InstancioCartesianProductApi
-
Applies given
modelto the specifiedselector. - setter(Class<?>, String) - Static method in class org.instancio.Select
-
Selects a setter method by name in the specified class.
- setter(Class<?>, String, Class<?>) - Static method in class org.instancio.Select
-
Selects a setter method by name and parameter type in the specified class.
- setter(String) - Static method in class org.instancio.Select
-
Selects a setter by name declared in the class being created.
- setter(SetMethodSelector<T, U>) - Static method in class org.instancio.Select
-
Selects a setter method based on the given method reference.
- SETTER_EXCLUDE_MODIFIER - Static variable in class org.instancio.settings.Keys
-
Specifies modifier exclusions for setter-methods; default is
0(no exclusions); property namesetter.exclude.modifier. - SETTER_STYLE - Static variable in class org.instancio.settings.Keys
-
Indicates the naming convention of setter methods to use; default is
SetterStyle.SET; property namesetter.style. - SetterStyle - Enum in org.instancio.settings
-
Specifies the style of setter to use when
AssignmentType.METHODis enabled. - SettingKey<T> - Interface in org.instancio.settings
-
A setting key represents a configuration item that can be stored in a
Settingsinstance. - SettingKey.SettingKeyBuilder<T> - Interface in org.instancio.settings
-
A builder for creating custom keys.
- Settings - Interface in org.instancio.settings
-
This class provides an API for updating settings programmatically.
- SettingsApi - Interface in org.instancio
-
Provides an API for specifying custom
Settings. - sha1() - Method in interface org.instancio.generator.specs.HashGeneratorSpec
-
Specifies that a SHA-1 hash should be generated.
- sha1() - Method in interface org.instancio.generator.specs.HashSpec
- sha256() - Method in interface org.instancio.generator.specs.HashGeneratorSpec
-
Specifies that a SHA-256 hash should be generated.
- sha256() - Method in interface org.instancio.generator.specs.HashSpec
- sha512() - Method in interface org.instancio.generator.specs.HashGeneratorSpec
-
Specifies that a SHA-512 hash should be generated.
- sha512() - Method in interface org.instancio.generator.specs.HashSpec
- SHORT_MAX - Static variable in class org.instancio.settings.Keys
-
Specifies maximum value for shorts; default is 10000; property name
short.max. - SHORT_MIN - Static variable in class org.instancio.settings.Keys
-
Specifies minimum value for shorts; default is 1; property name
short.min. - SHORT_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a
nullcan be generated for Short type; default isfalse; property nameshort.nullable. - shortRange(short, short) - Method in interface org.instancio.Random
-
Returns a random
shortwithin the given range. - shorts() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Generator for
Shortvalues. - shorts() - Method in interface org.instancio.generators.Generators
-
Generator for
Shortvalues. - shorts() - Method in interface org.instancio.generators.ValueSpecs
-
Generator for
Shortvalues. - shortSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
Shortspec for the given property name. - ShortSpec - Interface in org.instancio.generator.specs
-
Spec for generating
Shortvalues. - shuffle() - Method in class org.instancio.generator.hints.ArrayHint
-
Indicates whether array elements should be randomly shuffled.
- shuffle() - Method in class org.instancio.generator.hints.CollectionHint
-
Indicates whether collection elements should be shuffled.
- shuffle() - Method in interface org.instancio.generator.specs.EmitGeneratorSpec
-
Specifies that items should be emitted in random order.
- shuffle(boolean) - Method in class org.instancio.generator.hints.ArrayHint.Builder
-
Indicates whether array elements, once populated, should be randomly shuffled.
- shuffle(boolean) - Method in class org.instancio.generator.hints.CollectionHint.Builder
-
Indicates whether collection elements, once populated, should be randomly shuffled.
- shuffle(Collection<T>) - Method in interface org.instancio.generator.specs.ShuffleSpec
-
Creates a copy of the specified collection and shuffles its elements.
- shuffle(Collection<T>) - Method in interface org.instancio.generators.ValueSpecs
-
Creates a copy of the specified collection and shuffles its elements.
- shuffle(T...) - Method in interface org.instancio.generator.specs.ShuffleSpec
-
Creates a copy of the specified array and shuffles its elements.
- shuffle(T...) - Method in interface org.instancio.generators.ValueSpecs
-
Creates a copy of the specified array and shuffles its elements.
- ShuffleSpec<T> - Interface in org.instancio.generator.specs
-
Spec for shuffling elements in a random order, providing the results as a
Collection. - sin() - Method in interface org.instancio.generators.can.CanIdGenerators
-
Generates Social Insurance Number (SIN).
- sin() - Method in interface org.instancio.generators.can.CanIdSpecs
-
Generates Social Insurance Number (SIN).
- SinGeneratorSpec - Interface in org.instancio.generator.specs.can
-
Spec for generating Canadian Social Insurance Number (SIN).
- SinSpec - Interface in org.instancio.generator.specs.can
-
Spec for generating Canadian Social Insurance Number (SIN).
- size(int) - Method in interface org.instancio.generator.specs.CollectionGeneratorSpec
-
Size of collection to generate.
- size(int) - Method in interface org.instancio.generator.specs.EnumSetGeneratorSpec
-
Size of
EnumSetto generate. - size(int) - Method in interface org.instancio.generator.specs.MapGeneratorSpec
-
Size of map to generate.
- size(int) - Method in interface org.instancio.generator.specs.SizeGeneratorSpec
-
The exact size of the object to generate.
- size(int) - Method in interface org.instancio.InstancioCollectionsApi
-
Specifies collection size to generate.
- SizeGeneratorSpec<T> - Interface in org.instancio.generator.specs
-
Generator spec for specifying the size of an object.
- spatial() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Provides access to spatial data type related generators.
- spatial() - Method in interface org.instancio.generators.Generators
-
Provides access to spatial data type related generators.
- spatial() - Method in interface org.instancio.generators.ValueSpecs
-
Provides access to spatial data type related generators.
- SpatialGenerators - Interface in org.instancio.generators
-
Contains built-in spatial generators.
- SpatialSpecs - Interface in org.instancio.generators
-
Provides spatial data related generators.
- spec(String, Class<T>) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a spec for the given property name.
- spec(String, Function<String, T>) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a spec for the given property name.
- sqlDate() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises generated
Datevalues. - sqlDate() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises generated
Datevalues. - ssn() - Method in interface org.instancio.generators.usa.UsaIdGenerators
-
Generates Social Security Number (SSN).
- ssn() - Method in interface org.instancio.generators.usa.UsaIdSpecs
-
Generates Social Security Number (SSN).
- SsnGeneratorSpec - Interface in org.instancio.generator.specs.usa
-
Spec for generating US Social Security Number (SSN).
- SsnSpec - Interface in org.instancio.generator.specs.usa
-
Spec for generating US Social Security Number (SSN).
- start() - Method in interface org.instancio.IntervalSupplier
-
Returns a supplier that produces interval start value.
- start(T) - Method in interface org.instancio.generator.specs.NumericSequenceGeneratorSpec
-
Specifies the starting value of the sequence.
- start(T) - Method in interface org.instancio.generator.specs.NumericSequenceSpec
- startIndex(int) - Method in interface org.instancio.generator.specs.LuhnGeneratorSpec
-
The start index for calculating the checksum (default value is
0). - startIndex(int) - Method in interface org.instancio.generator.specs.LuhnSpec
- startIndex(int) - Method in interface org.instancio.generator.specs.Mod10GeneratorSpec
-
The start index for calculating the checksum (default value is
0). - startIndex(int) - Method in interface org.instancio.generator.specs.Mod10Spec
- startIndex(int) - Method in interface org.instancio.generator.specs.Mod11GeneratorSpec
-
The start index for calculating the checksum (default value is
0). - startIndex(int) - Method in interface org.instancio.generator.specs.Mod11Spec
-
The start index for calculating the checksum (default value is
0). - STATIC - Static variable in class org.instancio.settings.MethodModifier
-
Modifier for
staticmethod. - stream() - Method in interface org.instancio.generator.ValueSpec
-
Returns an infinite
Streamof values. - stream() - Method in interface org.instancio.InstancioApi
-
Creates an infinite
Streamof objects. - stream(Class<T>) - Static method in class org.instancio.Instancio
-
Creates an infinite stream of instances of the specified class.
- stream(Model<T>) - Static method in class org.instancio.Instancio
-
Creates an infinite stream of objects populated using the given model.
- stream(TypeTokenSupplier<T>) - Static method in class org.instancio.Instancio
-
Creates an infinite stream of objects of type specified by the type token.
- STRICT - Enum constant in enum org.instancio.settings.Mode
-
Triggers an exception if at least one selector was not used during object construction.
- string() - Element in annotation type org.instancio.feed.Feed.Source
-
Specifies inline data for a feed as a string.
- string() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Generator for
Stringvalues. - string() - Method in interface org.instancio.generators.Generators
-
Generator for
Stringvalues. - string() - Method in interface org.instancio.generators.ValueSpecs
-
Generator for
Stringvalues. - STRING_ALLOW_EMPTY - Static variable in class org.instancio.settings.Keys
-
Specifies whether an empty string can be generated; default is
false; property namestring.allow.empty. - STRING_CASE - Static variable in class org.instancio.settings.Keys
-
Specifies the case of generated strings; default is
StringCase.UPPER; property namestring.case. - STRING_FIELD_PREFIX_ENABLED - Static variable in class org.instancio.settings.Keys
-
Specifies whether generated Strings should be prefixed with field names; default is
false; property namestring.field.prefix.enabled. - STRING_MAX_LENGTH - Static variable in class org.instancio.settings.Keys
-
Specifies maximum length of strings; default is 10; property name
string.max.length. - STRING_MIN_LENGTH - Static variable in class org.instancio.settings.Keys
-
Specifies minimum length of strings; default is 3; property name
string.min.length. - STRING_NULLABLE - Static variable in class org.instancio.settings.Keys
-
Specifies whether a
nullcan be generated for String type; default isfalse; property namestring.nullable. - STRING_TYPE - Static variable in class org.instancio.settings.Keys
-
Specifies the String type to generate; default is
StringType.ALPHABETIC; property namestring.type. - StringCase - Enum in org.instancio.settings
-
A setting that specifies the case of generated strings.
- StringGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for Strings.
- stringOf(int, char...) - Method in interface org.instancio.Random
-
Generates a random String of the specified length comprised of given characters.
- stringSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
Stringspec for the given property name. - StringSpec - Interface in org.instancio.generator.specs
-
Spec for generating
Stringvalues. - StringType - Enum in org.instancio.settings
-
A setting that specifies the type of
Stringto generate. - subtype(Class<?>) - Method in interface org.instancio.generator.specs.ArrayGeneratorSpec
-
Specifies the type of array that should be generated.
- subtype(Class<?>) - Method in interface org.instancio.generator.specs.CollectionGeneratorSpec
-
Specifies the type of collection that should be generated.
- subtype(Class<?>) - Method in interface org.instancio.generator.specs.MapGeneratorSpec
-
Specifies the type of map that should be generated.
- subtype(Class<?>) - Method in interface org.instancio.generator.specs.SubtypeGeneratorSpec
-
Specifies the subtype that should be generated.
- subtype(TargetSelector, Class<?>) - Method in interface org.instancio.BaseApi
-
Maps target field or class to the given subtype.
- subtype(TargetSelector, Class<?>) - Method in interface org.instancio.InstancioApi
-
Maps target field or class to the given subtype.
- subtype(TargetSelector, Class<?>) - Method in interface org.instancio.InstancioCartesianProductApi
-
Maps target field or class to the given subtype.
- SubtypeGeneratorSpec<T> - Interface in org.instancio.generator.specs
-
Provides a method for specifying a specific subtype that should be generated.
- suffix(String) - Method in interface org.instancio.generator.specs.FilePathSpec
- suffix(String) - Method in interface org.instancio.generator.specs.FileSpec
- suffix(String) - Method in interface org.instancio.generator.specs.PathGeneratorSpec
-
File or directory name suffix.
- suffix(String) - Method in interface org.instancio.generator.specs.PathSpec
- suffix(String) - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Specifies the suffix to append to generated strings.
- suffix(String) - Method in interface org.instancio.generator.specs.StringSpec
- supply(Predicate<S>, Supplier<T>) - Method in interface org.instancio.GivenOriginDestination
-
Supplies an object using a
Supplier. - supply(Predicate<S>, Generator<T>) - Method in interface org.instancio.GivenOriginDestination
-
Supplies an object using a
Generatorto matching selector targets. - supply(Supplier<T>) - Method in interface org.instancio.ValueOf
-
Supplies an object using a
Supplier. - supply(Generator<T>) - Method in interface org.instancio.ValueOf
-
Supplies an object using a
Generatorto matching selector targets. - supply(TargetSelector, Supplier<T>) - Method in interface org.instancio.GivenOriginPredicate
-
Supplies an object using a
Supplier. - supply(TargetSelector, Supplier<V>) - Method in interface org.instancio.BaseApi
-
Supplies an object using a
Supplier. - supply(TargetSelector, Supplier<V>) - Method in interface org.instancio.InstancioApi
-
Supplies an object using a
Supplier. - supply(TargetSelector, Supplier<V>) - Method in interface org.instancio.InstancioCartesianProductApi
-
Supplies an object using a
Supplier. - supply(TargetSelector, Generator<T>) - Method in interface org.instancio.GivenOriginPredicate
-
Supplies an object using a
Generatorto matching selector targets. - supply(TargetSelector, Generator<V>) - Method in interface org.instancio.BaseApi
-
Supplies an object using a
Generatorto matching selector targets. - supply(TargetSelector, Generator<V>) - Method in interface org.instancio.InstancioApi
-
Supplies an object using a
Generatorto matching selector targets. - supply(TargetSelector, Generator<V>) - Method in interface org.instancio.InstancioCartesianProductApi
-
Supplies an object using a
Generatorto matching selector targets.
T
- TargetSelector - Interface in org.instancio
-
A
TargetSelectorfor selecting fields and classes. - temporal() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Provides access to temporal generators.
- temporal() - Method in interface org.instancio.generators.Generators
-
Provides access to temporal generators.
- temporal() - Method in interface org.instancio.generators.ValueSpecs
-
Provides access to temporal generators.
- TemporalGenerators - Interface in org.instancio.generators
-
Contains built-in temporal generators.
- TemporalGeneratorSpec<T> - Interface in org.instancio.generator.specs
-
Generator spec for
Temporaltypes. - TemporalSpec<T> - Interface in org.instancio.generator.specs
-
Spec for generating
Temporaltypes. - TemporalSpecs - Interface in org.instancio.generators
-
Provides generators for
java.timeclasses. - temporary() - Method in interface org.instancio.generator.specs.can.SinGeneratorSpec
-
Generates a temporary card number with the first digit
9. - temporary() - Method in interface org.instancio.generator.specs.can.SinSpec
- text() - Method in interface org.instancio.generators.CommonGeneratorSpecs
-
Provides access to text generators.
- text() - Method in interface org.instancio.generators.Generators
-
Provides access to text generators.
- text() - Method in interface org.instancio.generators.ValueSpecs
-
Provides access to text generators.
- TextGenerators - Interface in org.instancio.generators
-
Contains built-in text generators.
- TextPatternGeneratorSpec - Interface in org.instancio.generator.specs
-
Spec for generating strings based on a pattern.
- TextPatternSpec - Interface in org.instancio.generator.specs
-
Spec for generating strings based on a pattern.
- TextSpecs - Interface in org.instancio.generators
-
Provides text generators.
- threshold(int) - Method in interface org.instancio.generator.specs.Mod11GeneratorSpec
-
The threshold for the Mod11 algorithm multiplier growth, if no value is specified the multiplier will grow indefinitely (default value is
Integer.MAX_VALUE). - threshold(int) - Method in interface org.instancio.generator.specs.Mod11Spec
-
The threshold for the Mod11 algorithm multiplier growth, if no value is specified the multiplier will grow indefinitely (default value is
Integer.MAX_VALUE). - timestamp() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises generated
Timestampvalues. - timestamp() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises generated
Timestampvalues. - tituloEleitoral() - Method in interface org.instancio.generators.bra.BraIdGenerators
-
Generates Titulo Eleitoral
- tituloEleitoral() - Method in interface org.instancio.generators.bra.BraIdSpecs
-
Generates Titulo Eleitoral
- TituloEleitoralGeneratorSpec - Interface in org.instancio.generator.specs.bra
-
Spec for generating Brazilian 'Titulo de Eleitor' .
- TituloEleitoralSpec - Interface in org.instancio.generator.specs.bra
-
Spec for generating Brazilian 'Titulo de Eleitor' .
- tmp() - Method in interface org.instancio.generator.specs.FilePathSpec
- tmp() - Method in interface org.instancio.generator.specs.FileSpec
- tmp() - Method in interface org.instancio.generator.specs.PathGeneratorSpec
-
Generate path with
java.io.tmpdiras the parent directory. - tmp() - Method in interface org.instancio.generator.specs.PathSpec
- to(GetMethodSelector<T, R>) - Method in interface org.instancio.ValueOf
-
Specifies the destination method reference for the assignment.
- to(TargetSelector) - Method in interface org.instancio.ValueOf
-
Specifies the destination selector for the assignment.
- toModel() - Method in interface org.instancio.InstancioApi
-
Creates a model containing generation parameters for creating an object A model acts as a template for creating objects or other models.
- toScope() - Method in interface org.instancio.ConvertibleToScope
-
Scope representation of a selector.
- toScope() - Method in interface org.instancio.FieldSelectorBuilder
-
Scope representation of a selector.
- toScope() - Method in interface org.instancio.PredicateSelector
-
Scope representation of a selector.
- toScope() - Method in interface org.instancio.TypeSelectorBuilder
-
Scope representation of a selector.
- toString() - Method in class org.instancio.generator.hints.ArrayHint
- toString() - Method in class org.instancio.generator.hints.CollectionHint
- toString() - Method in class org.instancio.generator.hints.MapHint
- toString() - Method in class org.instancio.generator.Hints
- toString() - Method in enum org.instancio.settings.AssignmentType
- toString() - Method in enum org.instancio.settings.BeanValidationTarget
- toString() - Method in enum org.instancio.settings.OnSetFieldError
- toString() - Method in enum org.instancio.settings.OnSetMethodError
- toString() - Method in enum org.instancio.settings.OnSetMethodNotFound
- toString() - Method in enum org.instancio.settings.OnSetMethodUnmatched
- toString() - Method in enum org.instancio.settings.SetterStyle
- treatCheck10As(char) - Method in interface org.instancio.generator.specs.Mod11GeneratorSpec
-
The
charthat represents the check digit when the Mod11 checksum equals10(default value is'X'). - treatCheck10As(char) - Method in interface org.instancio.generator.specs.Mod11Spec
-
The
charthat represents the check digit when the Mod11 checksum equals10(default value is'X'). - treatCheck11As(char) - Method in interface org.instancio.generator.specs.Mod11GeneratorSpec
-
The
charthat represents the check digit when the Mod11 checksum equals11(default value is'0'). - treatCheck11As(char) - Method in interface org.instancio.generator.specs.Mod11Spec
-
The
charthat represents the check digit when the Mod11 checksum equals11(default value is'0'). - trim(FeedDataTrim) - Method in interface org.instancio.feed.FormatOptionsProvider.FormatOptions.CsvFormatOptions
-
Specifies whether values should be trimmed of whitespace.
- trueOrFalse() - Method in interface org.instancio.Random
-
Returns a random boolean with a
0.5probability. - trueOrFalse(double) - Method in interface org.instancio.Random
-
Returns
truewith the specified probability. - TruncatableTemporalGeneratorSpec<T> - Interface in org.instancio.generator.specs
-
A spec for truncating temporal values.
- truncatedTo(TemporalUnit) - Method in interface org.instancio.generator.specs.InstantGeneratorSpec
-
Truncates generated values to the specified unit.
- truncatedTo(TemporalUnit) - Method in interface org.instancio.generator.specs.InstantSpec
-
Truncates generated values to the specified unit.
- truncatedTo(TemporalUnit) - Method in interface org.instancio.generator.specs.LocalDateTimeGeneratorSpec
-
Truncates generated values to the specified unit.
- truncatedTo(TemporalUnit) - Method in interface org.instancio.generator.specs.LocalDateTimeSpec
-
Truncates generated values to the specified unit.
- truncatedTo(TemporalUnit) - Method in interface org.instancio.generator.specs.LocalTimeGeneratorSpec
-
Truncates generated values to the specified unit.
- truncatedTo(TemporalUnit) - Method in interface org.instancio.generator.specs.LocalTimeSpec
-
Truncates generated values to the specified unit.
- truncatedTo(TemporalUnit) - Method in interface org.instancio.generator.specs.OffsetDateTimeGeneratorSpec
-
Truncates generated values to the specified unit.
- truncatedTo(TemporalUnit) - Method in interface org.instancio.generator.specs.OffsetDateTimeSpec
-
Truncates generated values to the specified unit.
- truncatedTo(TemporalUnit) - Method in interface org.instancio.generator.specs.OffsetTimeGeneratorSpec
-
Truncates generated values to the specified unit.
- truncatedTo(TemporalUnit) - Method in interface org.instancio.generator.specs.OffsetTimeSpec
-
Truncates generated values to the specified unit.
- truncatedTo(TemporalUnit) - Method in interface org.instancio.generator.specs.TruncatableTemporalGeneratorSpec
-
Truncates generated values to the specified unit.
- truncatedTo(TemporalUnit) - Method in interface org.instancio.generator.specs.ZonedDateTimeGeneratorSpec
-
Truncates generated values to the specified unit.
- truncatedTo(TemporalUnit) - Method in interface org.instancio.generator.specs.ZonedDateTimeSpec
-
Truncates generated values to the specified unit.
- type() - Method in interface org.instancio.generator.Hint
-
Returns the type of this hint.
- type() - Method in interface org.instancio.settings.SettingKey
-
The type of value associated with this key.
- type13() - Method in interface org.instancio.generator.specs.EanGeneratorSpec
-
Specifies that EAN-13 should be generated (default behaviour if the type is not specified).
- type13() - Method in interface org.instancio.generator.specs.EanSpec
-
Specifies that EAN-13 should be generated (default behaviour if the type is not specified).
- type14() - Method in interface org.instancio.generator.specs.pol.RegonGeneratorSpec
-
Specifies that 14-digit REGON should be generated.
- type14() - Method in interface org.instancio.generator.specs.pol.RegonSpec
-
Specifies that 14-digit REGON should be generated.
- type8() - Method in interface org.instancio.generator.specs.EanGeneratorSpec
-
Specifies that EAN-8 should be generated.
- type8() - Method in interface org.instancio.generator.specs.EanSpec
-
Specifies that EAN-8 should be generated.
- type9() - Method in interface org.instancio.generator.specs.pol.RegonGeneratorSpec
-
Specifies that 9-digit REGON should be generated (default behaviour if the type is not specified).
- type9() - Method in interface org.instancio.generator.specs.pol.RegonSpec
-
Specifies that 9-digit REGON should be generated (default behaviour if the type is not specified).
- types() - Static method in class org.instancio.Select
-
Provides a builder for selecting types based on
Predicates. - types(Predicate<Class<?>>) - Static method in class org.instancio.Select
-
Select all types matching the specified predicate.
- TypeSelectorBuilder - Interface in org.instancio
-
A builder for constructing predicate-based type selectors.
- TypeToken<T> - Interface in org.instancio
-
A supplier that provides
Typeinformation. - TypeTokenSupplier<T> - Interface in org.instancio
-
A supplier that provides
Typeinformation.
U
- unicode(Character.UnicodeBlock...) - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Generates a Unicode string that consists of random code points excluding the following character types:
Character.PRIVATE_USECharacter.SURROGATECharacter.UNASSIGNED - unicode(Character.UnicodeBlock...) - Method in interface org.instancio.generator.specs.StringSpec
-
Generates a Unicode string that consists of random code points excluding the following character types:
Character.PRIVATE_USECharacter.SURROGATECharacter.UNASSIGNED - UNICODE - Enum constant in enum org.instancio.settings.StringType
-
Represents a Unicode string that consists of random code points, excluding the following character types:
Character.PRIVATE_USECharacter.SURROGATECharacter.UNASSIGNED - unique() - Method in class org.instancio.generator.hints.CollectionHint
-
Indicates whether collection should contain unique elements.
- unique() - Method in interface org.instancio.generator.specs.CollectionGeneratorSpec
-
Specifies that a collection containing unique elements should be generated.
- unique(boolean) - Method in class org.instancio.generator.hints.CollectionHint.Builder
-
Indicates that a collection containing unique elements should be generated.
- UNQUOTED - Enum constant in enum org.instancio.settings.FeedDataTrim
-
Unquoted data is trimmed of leading and trailing whitespace, for example when using data in CSV format.
- UnresolvedAssignmentException - Exception Class in org.instancio.exception
-
Exception triggered as a result of an assignment expression that could not be resolved.
- UnresolvedAssignmentException(String, Throwable) - Constructor for exception class org.instancio.exception.UnresolvedAssignmentException
- UnusedSelectorException - Exception Class in org.instancio.exception
-
Exception triggered as a result of unused selectors.
- UnusedSelectorException(String, Map<ApiMethodSelector, List<TargetSelector>>) - Constructor for exception class org.instancio.exception.UnusedSelectorException
- UPPER - Enum constant in enum org.instancio.settings.StringCase
-
Represents uppercase strings
[A-Z]. - upperCase() - Method in interface org.instancio.generator.specs.StringGeneratorSpec
-
Generates an uppercase string that consists of characters
[A-Z]. - upperCase() - Method in interface org.instancio.generator.specs.StringSpec
- upperCase() - Method in interface org.instancio.generator.specs.UUIDStringGeneratorSpec
-
Generate UUID String in uppercase characters.
- upperCase() - Method in interface org.instancio.generator.specs.UUIDStringSpec
- upperCaseAlphabetic(int) - Method in interface org.instancio.Random
-
Generates a random upper case String comprised of
[A-Z]. - upperCaseCharacter() - Method in interface org.instancio.Random
-
Returns a random upper alphabetic character,
[A-Z]. - uri() - Method in interface org.instancio.generators.NetGenerators
-
Customises generated
URIobjects. - uri() - Method in interface org.instancio.generators.NetSpecs
-
Customises generated
URIobjects. - URIGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for
URI. - URISpec - Interface in org.instancio.generator.specs
-
Spec for generating
URIvalues. - url() - Method in interface org.instancio.generators.NetGenerators
-
Customises generated
URLobjects. - url() - Method in interface org.instancio.generators.NetSpecs
-
Customises generated
URLobjects. - URLGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for
URL. - URLSpec - Interface in org.instancio.generator.specs
-
Spec for generating
URLvalues. - usa() - Method in interface org.instancio.generators.IdGenerators
-
Provides access to identifier generators for the USA.
- usa() - Method in interface org.instancio.generators.IdSpecs
-
Provides access to identifier generators for the USA.
- Usage - Search tag in class org.instancio.Instancio
- Section
- Usage with Java records - Search tag in org.instancio.BaseApi.ignore(TargetSelector)
- Section
- Usage with Java records - Search tag in org.instancio.BaseApi.ignore(TargetSelector)
- Section
- Usage with Java records - Search tag in org.instancio.BaseApi.ignore(TargetSelector)
- Section
- UsaIdGenerators - Interface in org.instancio.generators.usa
-
Contains built-in generators for USA identifiers.
- UsaIdSpecs - Interface in org.instancio.generators.usa
-
Provides generators for USA identifiers.
- userInfo(String) - Method in interface org.instancio.generator.specs.URIGeneratorSpec
-
Specifies username.
- userInfo(String) - Method in interface org.instancio.generator.specs.URISpec
-
Specifies username.
- uuid() - Method in interface org.instancio.generators.TextGenerators
-
Generates a
UUIDvalue as a string. - uuid() - Method in interface org.instancio.generators.TextSpecs
-
Generates a
UUIDvalue as a string. - uuid() - Method in interface org.instancio.generators.ValueSpecs
-
Generator for
UUIDvalues. - uuidSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
UUIDspec for the given property name. - UUIDSpec - Interface in org.instancio.generator.specs
-
Spec for generating
UUIDvalues. - UUIDStringGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for generating UUID strings.
- UUIDStringSpec - Interface in org.instancio.generator.specs
-
Spec for generating string representations of
UUIDvalues.
V
- value() - Element in annotation type org.instancio.feed.Feed.DataAccess
-
Specifies the data access strategy to be used by the annotated feed.
- value() - Element in annotation type org.instancio.feed.Feed.FormatType
-
Specifies the data format type for this feed.
- value() - Element in annotation type org.instancio.feed.Feed.TagKey
-
Specifies the name of a property to use as the tag key.
- value() - Element in annotation type org.instancio.feed.FeedSpecAnnotations.DataSpec
-
Specifies the name of a property that a spec method in a
Feedshould map to. - value() - Element in annotation type org.instancio.feed.FeedSpecAnnotations.GeneratedSpec
-
The generator class for producing data.
- value() - Element in annotation type org.instancio.feed.FeedSpecAnnotations.TemplateSpec
-
Specifies a string template that uses
${}syntax for placeholders. - value() - Element in annotation type org.instancio.feed.FeedSpecAnnotations.WithPostProcessor
-
One or more classes implementing the
PostProcessor. - value() - Element in annotation type org.instancio.feed.FeedSpecAnnotations.WithStringMapper
-
Specifies the function class to be used for string conversions.
- valueOf(Class<T>) - Static method in class org.instancio.Assign
-
Creates an assignment for a given target
type. - valueOf(String) - Static method in enum org.instancio.generator.AfterGenerate
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.instancio.settings.AssignmentType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.instancio.settings.BeanValidationTarget
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.instancio.settings.FeedDataAccess
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.instancio.settings.FeedDataEndAction
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.instancio.settings.FeedDataTrim
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.instancio.settings.FeedFormatType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.instancio.settings.Mode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.instancio.settings.OnSetFieldError
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.instancio.settings.OnSetMethodError
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.instancio.settings.OnSetMethodNotFound
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.instancio.settings.OnSetMethodUnmatched
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.instancio.settings.SetterStyle
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.instancio.settings.StringCase
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.instancio.settings.StringType
-
Returns the enum constant of this type with the specified name.
- valueOf(GetMethodSelector<T, R>) - Static method in class org.instancio.Assign
-
Creates an assignment for a given
targetmethod reference. - valueOf(TargetSelector) - Static method in class org.instancio.Assign
-
Creates an assignment builder with a given
targetselector. - ValueOf - Interface in org.instancio
-
Value of a target selector of an assignment.
- ValueOfOriginDestination - Interface in org.instancio
-
An assigment containing origin and destination selectors.
- ValueOfOriginDestinationPredicate - Interface in org.instancio
-
An assigment containing origin and destination selectors, and a predicate that the origin value must satisfy for the assignment to be applied.
- values() - Static method in enum org.instancio.generator.AfterGenerate
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.instancio.settings.AssignmentType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.instancio.settings.BeanValidationTarget
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.instancio.settings.FeedDataAccess
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.instancio.settings.FeedDataEndAction
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.instancio.settings.FeedDataTrim
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.instancio.settings.FeedFormatType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.instancio.settings.Mode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.instancio.settings.OnSetFieldError
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.instancio.settings.OnSetMethodError
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.instancio.settings.OnSetMethodNotFound
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.instancio.settings.OnSetMethodUnmatched
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.instancio.settings.SetterStyle
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.instancio.settings.StringCase
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.instancio.settings.StringType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- ValueSpec<T> - Interface in org.instancio.generator
-
A spec for generating simple value types, such as strings, numbers, dates, and so on.
- ValueSpecs - Interface in org.instancio.generators
-
Defines all built-in generators that are available via the
Instancio.gen()method. - verbose() - Method in interface org.instancio.InstancioApi
-
Outputs debug information to
System.out. - verbose() - Method in interface org.instancio.InstancioCartesianProductApi
-
Outputs debug information to
System.out. - verbose() - Method in interface org.instancio.VerboseModeApi
-
Outputs debug information to
System.out. - VerboseModeApi - Interface in org.instancio
-
Provides support for verbose mode.
- visa() - Method in interface org.instancio.generator.specs.CreditCardGeneratorSpec
-
Specifies that Visa credit card numbers should be generated.
- visa() - Method in interface org.instancio.generator.specs.CreditCardSpec
W
- weight(int) - Method in interface org.instancio.generator.specs.Mod10GeneratorSpec
-
The weight to be used for even digits when calculating the Mod10 checksum (default value is
1). - weight(int) - Method in interface org.instancio.generator.specs.Mod10Spec
- when(Predicate<T>) - Method in interface org.instancio.ValueOfOriginDestination
-
A predicate that must be satisfied by the value matched by the origin selector.
- when(Predicate<T>) - Method in interface org.instancio.ValueOfOriginDestinationPredicate
-
A predicate that must be satisfied by the value matched by the origin selector.
- When - Class in org.instancio
-
Provides convenience methods for creating
Predicates. - whenEmptyEmitNull() - Method in interface org.instancio.generator.specs.EmitGeneratorSpec
-
Specifies that
nullshould be generated if an insufficient number of items were provided. - whenEmptyEmitRandom() - Method in interface org.instancio.generator.specs.EmitGeneratorSpec
-
Specifies that a random value should be generated if an insufficient number of items were provided (default behaviour).
- whenEmptyRecycle() - Method in interface org.instancio.generator.specs.EmitGeneratorSpec
-
Specifies that the same items should be re-emitted again if provided items are exhausted.
- whenEmptyThrowException() - Method in interface org.instancio.generator.specs.EmitGeneratorSpec
-
Specifies that an exception should be raised if an insufficient number of items were provided.
- with(K, V) - Method in interface org.instancio.generator.specs.MapGeneratorSpec
-
Adds given key/value pair to the generated map.
- with(TargetSelector, V...) - Method in interface org.instancio.InstancioCartesianProductApi
-
Sets a range of values for generating the Cartesian product.
- with(T) - Method in class org.instancio.generator.Hints.Builder
-
Adds specified hint object.
- with(T...) - Method in interface org.instancio.generator.specs.ArrayGeneratorSpec
-
Adds given elements to the generated array at random positions.
- with(T...) - Method in interface org.instancio.generator.specs.CollectionGeneratorSpec
-
Adds given elements to the generated collection at random positions.
- WITH - Enum constant in enum org.instancio.settings.SetterStyle
-
Setters with "with" prefix, for example
withFoo("value") - withDataSource(DataSourceProvider) - Method in interface org.instancio.InstancioFeedApi
-
Specifies the data source for a
Feed, for example: - withElements() - Method in class org.instancio.generator.hints.ArrayHint
-
Returns elements provided by the generator to the engine that are to be inserted into the array.
- withElements() - Method in class org.instancio.generator.hints.CollectionHint
-
Returns additional elements provided by the generator to the engine that are to be inserted into the collection.
- withElements(List<? extends T>) - Method in class org.instancio.generator.hints.ArrayHint.Builder
-
Additional elements to be inserted into the array by the engine during the population process.
- withElements(List<? extends T>) - Method in class org.instancio.generator.hints.CollectionHint.Builder
-
Additional elements to be inserted into the collection by the engine during the population process.
- withEntries() - Method in class org.instancio.generator.hints.MapHint
-
Returns additional entries provided by the generator to the engine that are to be inserted into the map.
- withEntries(Map<? extends K, ? extends V>) - Method in class org.instancio.generator.hints.MapHint.Builder
-
The specified entries will be inserted into the map by the engine during the population process.
- within(Scope...) - Method in interface org.instancio.FieldSelectorBuilder
-
Specifies the scope for this selector in order to narrow down its target.
- within(Scope...) - Method in interface org.instancio.PredicateSelector
-
Specifies the scope for this selector in order to narrow down its target.
- within(Scope...) - Method in interface org.instancio.ScopeableSelector
-
Specifies the scope for this selector in order to narrow down its target.
- within(Scope...) - Method in interface org.instancio.Selector
-
Specifies the scope for this selector in order to narrow down its target.
- within(Scope...) - Method in interface org.instancio.TypeSelectorBuilder
-
Specifies the scope for this selector in order to narrow down its target.
- within(Scope...) - Method in interface org.instancio.WithinScope
-
Specifies the scope for this selector in order to narrow down its target.
- WithinScope - Interface in org.instancio
-
Adds ability to narrow down selector targets using
Scope. - withKeys() - Method in class org.instancio.generator.hints.MapHint
-
Returns keys provided by the generator to the engine that are to be inserted into the map.
- withKeys(List<? extends K>) - Method in class org.instancio.generator.hints.MapHint.Builder
-
The specified keys will be inserted into the map by the engine during the population process.
- withKeys(K...) - Method in interface org.instancio.generator.specs.MapGeneratorSpec
-
Adds given keys to the map in the order they are provided.
- withMaxDepth(int) - Method in interface org.instancio.BaseApi
-
Specifies the maximum depth for populating an object.
- withMaxDepth(int) - Method in interface org.instancio.InstancioApi
-
Specifies the maximum depth for populating an object.
- withMaxDepth(int) - Method in interface org.instancio.InstancioCartesianProductApi
-
Specifies the maximum depth for populating an object.
- withNullable(TargetSelector) - Method in interface org.instancio.BaseApi
-
Specifies that a field or class is nullable.
- withNullable(TargetSelector) - Method in interface org.instancio.InstancioApi
-
Specifies that a field or class is nullable.
- withNullable(TargetSelector) - Method in interface org.instancio.InstancioCartesianProductApi
-
Specifies that a field or class is nullable.
- withoutDashes() - Method in interface org.instancio.generator.specs.UUIDStringGeneratorSpec
-
Generate UUID String without dashes.
- withoutDashes() - Method in interface org.instancio.generator.specs.UUIDStringSpec
- withPropertyKey(String) - Method in interface org.instancio.settings.SettingKey.SettingKeyBuilder
-
Specifies the property key.
- withSeed(long) - Method in interface org.instancio.BaseApi
-
Sets the seed value for the random number generator.
- withSeed(long) - Method in interface org.instancio.InstancioApi
-
Sets the seed value for the random number generator.
- withSeed(long) - Method in interface org.instancio.InstancioCartesianProductApi
-
Sets the seed value for the random number generator.
- withSetting(SettingKey<V>, V) - Method in interface org.instancio.InstancioApi
-
Overrides the setting for the given
keywith the specifiedvalue. - withSetting(SettingKey<V>, V) - Method in interface org.instancio.InstancioCartesianProductApi
-
Overrides the setting for the given
keywith the specifiedvalue. - withSetting(SettingKey<V>, V) - Method in interface org.instancio.InstancioFeedApi
-
Overrides the setting for the given
keywith the specifiedvalue. - withSetting(SettingKey<V>, V) - Method in interface org.instancio.InstancioGenApi
-
Overrides the setting for the given
keywith the specifiedvalue. - withSetting(SettingKey<V>, V) - Method in interface org.instancio.SettingsApi
-
Overrides the setting for the given
keywith the specifiedvalue. - withSettings(Settings) - Method in interface org.instancio.InstancioApi
-
Merges the specified
Settingswith the current settings, allowing for the addition and update of settings. - withSettings(Settings) - Method in interface org.instancio.InstancioCartesianProductApi
-
Merges the specified
Settingswith the current settings, allowing for the addition and update of settings. - withSettings(Settings) - Method in interface org.instancio.InstancioFeedApi
-
Merges the specified
Settingswith the current settings, allowing for the addition and update of settings. - withSettings(Settings) - Method in interface org.instancio.InstancioGenApi
-
Merges the specified
Settingswith the current settings, allowing for the addition and update of settings. - withSettings(Settings) - Method in interface org.instancio.SettingsApi
-
Merges the specified
Settingswith the current settings, allowing for the addition and update of settings. - withTagKey(String) - Method in interface org.instancio.FeedApi
-
Specifies the tag key for filtering records in the data feed.
- withTagKey(String) - Method in interface org.instancio.InstancioFeedApi
-
Specifies the tag key for filtering records in the data feed.
- withTagValue(String) - Method in interface org.instancio.FeedApi
-
Specifies the tag value of the records to fetch.
- withTagValue(String) - Method in interface org.instancio.InstancioFeedApi
-
Specifies the tag value of the records to fetch.
- withTypeParameters(Class<?>...) - Method in interface org.instancio.InstancioClassApi
-
Method for supplying type parameters for generic classes.
- withUnique(TargetSelector) - Method in interface org.instancio.BaseApi
-
Specifies that the given selector's target(s) should have unique values.
- withUnique(TargetSelector) - Method in interface org.instancio.InstancioApi
-
Specifies that the given selector's target(s) should have unique values.
- withUnique(TargetSelector) - Method in interface org.instancio.InstancioCartesianProductApi
-
Specifies that the given selector's target(s) should have unique values.
- words(int) - Method in interface org.instancio.generator.specs.LoremIpsumGeneratorSpec
-
Number of words to generate.
- words(int) - Method in interface org.instancio.generator.specs.LoremIpsumSpec
- wrapIf(Predicate<Object>) - Method in interface org.instancio.generator.specs.CsvGeneratorSpec
-
A condition that must be satisfied to wrap a value.
- wrapIf(Predicate<Object>) - Method in interface org.instancio.generator.specs.CsvSpec
-
A condition that must be satisfied to wrap a value.
- wrapWith(String) - Method in interface org.instancio.generator.specs.CsvGeneratorSpec
-
A string to wrap the values with, for example quotes.
- wrapWith(String) - Method in interface org.instancio.generator.specs.CsvSpec
-
A string to wrap the values with, for example quotes.
Y
- year() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises generated
Yearvalues. - year() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises generated
Yearvalues. - yearMonth() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises generated
YearMonthvalues. - yearMonth() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises generated
YearMonthvalues. - yearMonthSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
YearMonthspec for the given property name. - YearMonthSpec - Interface in org.instancio.generator.specs
-
Spec for generating
YearMonthvalues. - years(int, int) - Method in interface org.instancio.generator.specs.PeriodGeneratorSpec
-
Generate number of
Periodyears in the given range. - years(int, int) - Method in interface org.instancio.generator.specs.PeriodSpec
-
Generate number of
Periodyears in the given range. - yearSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
Yearspec for the given property name. - YearSpec - Interface in org.instancio.generator.specs
-
Spec for generating
Yearvalues.
Z
- zonedDateTime() - Method in interface org.instancio.generators.TemporalGenerators
-
Customises generated
ZonedDateTimevalues. - zonedDateTime() - Method in interface org.instancio.generators.TemporalSpecs
-
Customises generated
ZonedDateTimevalues. - ZonedDateTimeGeneratorSpec - Interface in org.instancio.generator.specs
-
Generator spec for
ZonedDateTime. - zonedDateTimeSpec(String) - Method in interface org.instancio.feed.FeedSpecAccessors
-
Returns a
ZonedDateTimespec for the given property name. - ZonedDateTimeSpec - Interface in org.instancio.generator.specs
-
Spec for generating
ZonedDateTimevalues.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form