https://github.com/arangodb/jackson-dataformat-velocypack

https://github.com/arangodb/jackson-dataformat-velocypack

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/arangodb/jackson-dataformat-velocypack
• Owner: arangodb
• License: apache-2.0
• Created: 2017-03-20T12:42:47.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2024-12-19T10:28:44.000Z (6 months ago)
• Last Synced: 2025-04-07T00:13:53.848Z (2 months ago)
• Language: Java
• Size: 999 KB
• Stars: 13
• Watchers: 41
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![ArangoDB-Logo](https://user-images.githubusercontent.com/3998723/207981337-79d49127-48fc-4c7c-9411-8a688edca1dd.png)

# VelocyPack dataformat for Jackson

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.arangodb/jackson-dataformat-velocypack/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.arangodb/jackson-dataformat-velocypack)

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/arangodb/jackson-dataformat-velocypack/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/arangodb/jackson-dataformat-velocypack/tree/main)

This project contains a [Jackson](https://github.com/FasterXML/jackson) extension for reading and writing [VelocyPack](https://github.com/arangodb/velocypack) encoded data.

## Maven

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

```XML

  

    com.arangodb

    jackson-dataformat-velocypack

    x.y.z

  

```

## Usage

Just create an instance of `VPackMapper` simply by:

```java

ObjectMapper mapper = new VPackMapper();

```

## Jackson datatype and language modules

The `VPackMapper` can be configured with [Jackson datatype modules](https://github.com/FasterXML/jackson#third-party-datatype-modules)

as well as [Jackson JVM Language modules](https://github.com/FasterXML/jackson#jvm-language-modules).

### Kotlin

[Kotlin language module](https://github.com/FasterXML/jackson-module-kotlin) enables support for Kotlin native types 

and can be registered in the following way:

```kotlin

val mapper = VPackMapper().apply {

    registerModule(KotlinModule())

}

```

### Scala

[Scala language module](https://github.com/FasterXML/jackson-module-scala) enables support for Scala native types 

and can be registered in the following way:

```scala

val mapper = new VPackMapper()

mapper.registerModule(DefaultScalaModule)

```

# Learn more

- [ArangoDB](https://www.arangodb.com/)

- [ChangeLog](ChangeLog.md)