Skip to content

Getting Started

Requirements:

Instancio is packaged as a multi-release JAR and can be used with Java 8 or higher.

It has a single compile dependency on org.slf4j:slf4j-api.

Since version 1.5.0 Instancio supports creating:

  • java.lang.Record classes on Java 16
  • sealed classes on Java 17

Dependencies

The following dependencies are available from Maven central:

DependencyJPMS Module NameDescription
instancio-coreorg.instancio.coreCore library
instancio-junitorg.instancio.junitJUnit Jupiter integration
instancio-guavaorg.instancio.guavaSupport for Google Guava
instancio-quickcheckorg.instancio.quickcheckSupport for property-based testing

The org.instancio:instancio artifact on Maven central is an older dependency that should no longer be used.

instancio-junit

If you have JUnit 5 on the classpath, then use instancio-junit.

It includes a transitive dependency on instancio-core, therefore it is not necessary to import both.

Maven
1
2
3
4
5
6
<dependency>
    <groupId>org.instancio</groupId>
    <artifactId>instancio-junit</artifactId>
    <version>4.7.0</version>
    <scope>test</scope>
</dependency>
Gradle
1
2
3
dependencies {
    testImplementation 'org.instancio:instancio-junit:4.7.0'
}

instancio-core

If you use JUnit 4, TestNG, or would like to use Instancio standalone, then use instancio-core:

Maven
1
2
3
4
5
6
<dependency>
    <groupId>org.instancio</groupId>
    <artifactId>instancio-core</artifactId>
    <version>4.7.0</version>
    <scope>test</scope>
</dependency>
Gradle
1
2
3
dependencies {
    testImplementation 'org.instancio:instancio-core:4.7.0'
}

instancio-guava

Using instancio-guava requires the following dependencies on the classpath:

  • either instancio-core or instancio-junit
  • com.google.guava:guava version 23.1-jre or higher

instancio-quickcheck

Using instancio-quickcheck requires the following dependencies on the classpath:

  • either instancio-core or instancio-junit
  • JUnit 5 version 5.10.1 or above

Note

Since instancio-quickcheck implements a JUnit 5 engine, it relies on a number of JUnit APIs. For this reason, it is only guaranteed to work with the JUnit version declared in the project's pom.xml. Support for older versions of Junit 5 is on a best-effort basis and is not guaranteed.

Versioning

Instancio version numbers adhere to the MAJOR.MINOR.PATCH format.

  • Major versions are generally reserved for significant features and breaking changes.
  • Minor and Patch versions include bug fixes, smaller new features, but may also include minor breaking changes.

In other words, the project does not follow Semantic Versioning, though the versioning scheme loosely resembles it.