README.md

VelocyPack dataformat for Jackson

This project contains a Jackson extension for reading and writing VelocyPack encoded data.

Maven

To add the dependency to your project with maven, add the following code to your pom.xml:

<dependencies>
  <dependency>
    <groupId>com.arangodb</groupId>
    <artifactId>jackson-dataformat-velocypack</artifactId>
    <version>x.y.z</version>
  </dependency>
</dependencies>

Usage

Just create an instance of VPackMapper simply by:

ObjectMapper mapper = new VPackMapper();

Jackson datatype and language modules

The VPackMapper can be configured with Jackson datatype modules as well as Jackson JVM Language modules.

Kotlin

Kotlin language module enables support for Kotlin native types and can be registered in the following way:

val mapper = VPackMapper().apply {
    registerModule(KotlinModule())
}

Scala

Scala language module enables support for Scala native types and can be registered in the following way:

val mapper = new VPackMapper()
mapper.registerModule(DefaultScalaModule)

Learn more

• ArangoDB
• ChangeLog