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:

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.

1
2
3
4
5
6

<dependency>
    <groupId>org.instancio</groupId>
    <artifactId>instancio-junit</artifactId>
    <version>4.5.1</version>
    <scope>test</scope>
</dependency>

1
2
3

dependencies {
    testImplementation 'org.instancio:instancio-junit:4.5.1'
}

instancio-core¶

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

1
2
3
4
5
6

<dependency>
    <groupId>org.instancio</groupId>
    <artifactId>instancio-core</artifactId>
    <version>4.5.1</version>
    <scope>test</scope>
</dependency>

1
2
3

dependencies {
    testImplementation 'org.instancio:instancio-core:4.5.1'
}

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