jackson-module-scala

![Build Status](https://github.com/FasterXML/jackson-module-scala/actions/workflows/ci.yml/badge.svg?branch=3.x)
![Maven Central Version](https://img.shields.io/maven-central/v/tools.jackson.module/jackson-module-scala_2.13)
[![Sonatype Snapshots](https://img.shields.io/nexus/s/https/central.sonatype.com/tools.jackson.module/jackson-module-scala_2.13.svg)](https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/tools/jackson/module/jackson-module-scala_2.13/)
[![Tidelift](https://tidelift.com/badges/package/maven/com.fasterxml.jackson.module:jackson-module-scala_2.13)](https://tidelift.com/subscription/pkg/maven-com.fasterxml.jackson.module.jackson-module-scala.2.13?utm_source=maven-com.fasterxml.jackson.module.jackson-module-scala.2.13&utm_medium=github_sponsor_button&utm_campaign=readme)

# Overview

[Jackson] is a fast JSON processor for Java that supports three models:
streaming, node, and object mapping (akin to the three independent models
[SAX]/[Stax], [DOM] and [JAXB] for XML processing).

The object mapping model is a high-level processing model that allows the
user to project JSON data onto a domain-specific data model appropriate
for their application, without having to deal with the low-level mechanics
of JSON parsing. It is the standard object mapping parser implementaton
in [Jersey], the reference implementation for JSR-311
(Java API for
Restful Web Services).

[Scala] is a functional programming language for the JVM that supports
Java interoperability. Its standard library is quite distinct from Java,
and does not fulfill the expectations of Jacksons default mappings.
Notably, Scala collections do not derive from `java.util.Collection` or
its subclasses, and Scala properties do not (by default) look like `Java Bean` properties.

The Scala Module supports serialization and limited deserialization of
Scala Case Classes, `Sequence`s, `Map`s, `Tuple`s, `Option`s, and Enumerations.

# Version Support

Jackson-module-scala follows the same release strategy of [jackson-databind](https://github.com/FasterXML/jackson-databind).
3.x branch is used for Jackson 3 development.

Scala 2.12, 2.13, 3.3+ are supported. Scala 2.11 support was dropped in v3.0.0. Java 17 is
the minimum supported version now (Jackson 3 generally has a minimum requirement of Java 17).

## Scala 3

There are a few differences from Scala 2 support.
* There are still a few tests that work with Scala 2 that fail with Scala 3
* It is expected that most use cases should work ok with Scala 3
  * Known issues with using jackson-module-scala with Scala 3 are tracked at https://github.com/FasterXML/jackson-module-scala/labels/scala3
  * There has been limited testing of using Scala 3 classes with Scala 2 jackson-module-scala or Scala 2 classes with Scala 3 jackson-module-scala
* Scala 3 emits no generic signature for a local or anonymous class ([scala/scala3#6349](https://github.com/scala/scala3/issues/6349)),
  so a `Map[String, Base]` member of `new { ... }`