Skip to content

Commit

Permalink
Update READMEs wrt 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
cowtowncoder committed Nov 10, 2023
1 parent d3b6f9a commit 5dc1f12
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 38 deletions.
24 changes: 3 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ for more mature (and generally slower moving, stable) modules.
Currently included are:

* [Afterburner](afterburner/) --
* [Blackbird](blackbird/) (NEW in 2.12 -- to eventually replace Afterburner)
* [Blackbird](blackbird/)
* Guice
* "Old" (`javax.inject`) based versions: [Guice](guice/)
* New "Jakarta" (`jakarta.inject`) based versions: [Guice 7](guice7/) (added in 2.16)
* Java XML Binding Annotation compatibility
* "Old" (`java.xml.bind`) annotations: [JAXB Annotations](jaxb/)
* New "Jakarta" (`jakarta.xml.bind`): [Jakarta XML Bind Annotations](jakarta-xmlbind/) (added in 2.13)
* [Mr Bean](mrbean/)
* [No-Constructor-Deserialization](no-ctor-deser/) (added in 2.13)
* [No-Constructor-Deserialization](no-ctor-deser/)
* [OSGi](osgi/)
* [Paranamer](paranamer/)

Expand All @@ -38,31 +38,13 @@ whereas 3.0 will use [ByteBuddy](https://github.com/raphw/byte-buddy) (licensed

## Using Jakarta

### Jackson 2.13 and later (once released)

With 2.13, you need to choose either:
You need to choose either:

* `jackson-module-jaxb-annotations` for "old JAXB" (2.x): supports `javax.xml.bind` annotations
* `jackson-module-jakarta-xmlbind-annotations` for "new Jakarta JAXB" (3.x): supports `jakarta.xml.bind` annotations

(in theory you can even use both, with databind `AnnotationIntrospectorPair`, but more often you will only want one of these)

Note that Jakarta version was added in Jackson 2.13 and was not available for earlier versions.

### Jackson 2.12 (only)

Alternatively if using Jackson 2.12, there is a specific variant of `jackson-module-jaxb-annotations`
available, usable with Maven classifier of "jakarta". You can use it instead of "old" JAXB variant
by specifying classifier like so:

```
<dependency>
<groupId>com.fasterxml.jackson.module</groupId>
<artifactId>jackson-module-jaxb-annotations</artifactId>
<classifier>jakarta</classifier>
</dependency>
```

## More

See [Wiki](../../wiki) for more information (javadocs).
10 changes: 5 additions & 5 deletions afterburner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Module is considered stable and has been used in production environments since v
There is, however, a potential future replacement available (as of Jackson 2.12): Blackbird module.
See the parent README for details.

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.jackson.module/jackson-module-afterburner/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.jackson.module/jackson-module-afterburner/)
[![Javadoc](https://javadoc.io/badge/com.fasterxml.jackson.module/jackson-module-afterburner.svg)](http://www.javadoc.io/doc/com.fasterxml.jackson.module/jackson-module-afterburner)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/tools.jackson.module/jackson-module-afterburner/badge.svg)](https://maven-badges.herokuapp.com/maven-central/tools.jackson.module/jackson-module-afterburner/)
[![Javadoc](https://javadoc.io/badge/tools.jackson.module/jackson-module-afterburner.svg)](http://www.javadoc.io/doc/tools.jackson.module/jackson-module-afterburner)

## Usage

Expand All @@ -19,17 +19,17 @@ To use module on Maven-based projects, use following dependency:

```xml
<dependency>
<groupId>com.fasterxml.jackson.module</groupId>
<groupId>tools.jackson.module</groupId>
<artifactId>jackson-module-afterburner</artifactId>
<version>2.12.0</version>
<version>3.0.0-SNAPSHOT</version>
</dependency>
```

(or whatever version is most up-to-date at the moment)

### Non-Maven

For non-Maven use cases, you download jars from [Central Maven repository](http://repo1.maven.org/maven2/com/fasterxml/jackson/module/jackson-module-afterburner/).
For non-Maven use cases, you download jars from [Central Maven repository](http://repo1.maven.org/maven2/tools/jackson/module/jackson-module-afterburner/).

Module jar is also a functional OSGi bundle, with proper import/export declarations, so it can be use on OSGi container as is.

Expand Down
2 changes: 1 addition & 1 deletion android-record/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ ObjectMapper mapper = JsonMapper.builder() // or mapper for other dataformats

Maven information for jar is:

* Group id: `com.fasterxml.jackson.module`
* Group id: `tools.jackson.module`
* Artifact id: `jackson-module-android-record`

## Other
Expand Down
4 changes: 2 additions & 2 deletions blackbird/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ Blackbird passes all the original Afterburner tests (except a couple that didn't

### Maven dependency

Blackbird is available on Maven Central as of 2.12.0:
Blackbird is available on Maven Central:

```xml
<dependency>
<groupId>com.fasterxml.jackson.module</groupId>
<groupId>tools.jackson.module</groupId>
<artifactId>jackson-module-blackbird</artifactId>
</dependency>
```
Expand Down
4 changes: 2 additions & 2 deletions jakarta-xmlbind/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ To use this extension on Maven-based projects, use following dependency:

```xml
<dependency>
<groupId>com.fasterxml.jackson.module</groupId>
<groupId>tools.jackson.module</groupId>
<artifactId>jackson-module-jakarta-xmlbind-annotations</artifactId>
<version>2.13.0</version>
<version>3.0.0-SNAPSHOT</version>
</dependency>
```

Expand Down
4 changes: 2 additions & 2 deletions jaxb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ To use this extension on Maven-based projects, use following dependency:

```xml
<dependency>
<groupId>com.fasterxml.jackson.module</groupId>
<groupId>tools.jackson.module</groupId>
<artifactId>jackson-module-jaxb-annotations</artifactId>
<version>2.11.0</version>
<version>3.0.0-SNAPSHOT</version>
</dependency>
```

Expand Down
11 changes: 6 additions & 5 deletions mrbean/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ To use module on Maven-based projects, use following dependency:

```xml
<dependency>
<groupId>com.fasterxml.jackson.module</groupId>
<groupId>tools.jackson.module</groupId>
<artifactId>jackson-module-mrbean</artifactId>
<version>2.11.0</version>
<version>3.0.0-SNAPSHOT</version>
</dependency>
```

Expand All @@ -29,9 +29,10 @@ To use module on Maven-based projects, use following dependency:
To use the the Module in Jackson, simply register it with the ObjectMapper instance:

```java
ObjectMapper mapper = new ObjectMapper()
// com.fasterxml.jackson.module.mrbean.MrBeanModule:
mapper.registerModule(new MrBeanModule());
ObjectMapper mapper = JsonMapper.builder()
// tools.jackson.module.mrbean.MrBeanModule:
.addModule(new MrBeanModule())
.build();
```

### Simple usage
Expand Down

0 comments on commit 5dc1f12

Please sign in to comment.