Skip to content

update readmes #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cowtowncoder merged 5 commits into from
Jan 2, 2026
Merged

update readmes #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7567fc5
Update Guava dependency version in README
pjfanning Jan 2, 2026
e863369
Update README with new Maven groupId and version
pjfanning Jan 2, 2026
79b1292
Revise README for Maven dependency and JDK version
pjfanning Jan 2, 2026
0ab1f10
more updates
pjfanning Jan 2, 2026
7712ca7
Update README.md
pjfanning Jan 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ To use these format backends Maven-based projects, use following dependency:

```xml
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<groupId>tools.jackson.datatype</groupId>
<artifactId>jackson-datatype-[COLLECTION]</artifactId>
<version>3.0.0-rc5</version>
<version>3.0.3</version>
</dependency>
```

Expand Down
13 changes: 7 additions & 6 deletions eclipse-collections/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.

## Status

[![Maven Central](https://img.shields.io/maven-central/v/com.fasterxml.jackson.datatype/jackson-datatype-eclipse-collections.svg)](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.jackson.datatype/jackson-datatype-eclipse-collections/)
[![Javadoc](https://javadoc.io/badge/com.fasterxml.jackson.datatype/jackson-datatype-eclipse-collections.svg)](https://www.javadoc.io/doc/com.fasterxml.jackson.datatype/jackson-datatype-eclipse-collections)
[![Maven Central](https://img.shields.io/maven-central/v/tools.jackson.datatype/jackson-datatype-eclipse-collections.svg)](https://maven-badges.herokuapp.com/maven-central/tools.jackson.datatype/jackson-datatype-eclipse-collections/)
[![Javadoc](https://javadoc.io/badge/tools.jackson.datatype/jackson-datatype-eclipse-collections.svg)](https://www.javadoc.io/doc/tools.jackson.datatype/jackson-datatype-eclipse-collections)

## Usage

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

```xml
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<groupId>tools.jackson.datatype</groupId>
<artifactId>jackson-datatype-eclipse-collections</artifactId>
<version>2.14.0</version>
<version>3.0.3</version>
</dependency>
```

Expand All @@ -30,8 +30,9 @@ To use module on Maven-based projects, use following dependency:
Like all standard Jackson modules (libraries that implement Module interface), registration is done as follows:

```java
ObjectMapper mapper = new ObjectMapper()
.registerModule(new EclipseCollectionsModule());
ObjectMapper mapper = JsonMapper.builder()
.addModule(new EclipseCollectionsModule())
.build();
```

after which functionality is available for all normal Jackson operations.
Expand Down
4 changes: 2 additions & 2 deletions guava/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ To use module on Maven-based projects, use following dependency:

```xml
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<groupId>tools.jackson.datatype</groupId>
<artifactId>jackson-datatype-guava</artifactId>
<version>3.0.0-rc5</version>
<version>3.0.3</version>
</dependency>
```

Expand Down
18 changes: 9 additions & 9 deletions hppc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.

## Status

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

Currently (2.7) following things are supported:
Currently, the following things are supported:

* Serializing of all 'XxxContainer' (IntContainer, IntSet, IntArrayList, LongContainer, DoubleContainer etc) types
* Deserialization of all `int` valued container types
Expand All @@ -28,18 +28,17 @@ contribute code. Jackson team is happy to merge code contributions, and help wit

### JDK version

Starting with version 2.6 of the module, minimum JDK is 1.7. This is because
HPPC 0.7.1 requires it. Jackson core components only require 1.6.
Starting with version 3.0 of the module, minimum JDK is 17.

### Maven dependency

To use module on Maven-based projects, use following dependency:

```xml
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<groupId>tools.jackson.datatype</groupId>
<artifactId>jackson-datatype-hppc</artifactId>
<version>2.5.3</version>
<version>3.0.3</version>
</dependency>
```

Expand All @@ -51,8 +50,9 @@ To use the the Module in Jackson, simply register it with the ObjectMapper insta
Modules are registered through ObjectMapper, like so:

```java
ObjectMapper mapper = new ObjectMapper();
mapper.register(new HppcModule());
ObjectMapper mapper = JsonMapper.builder()
.addModule(new HppcModule())
.build();
```

after which you can read JSON as HPPC types, as well as write HPPC types as JSON. It's really that simple; convenient and efficient.
13 changes: 7 additions & 6 deletions pcollections/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.

## Status

[![Maven Central](https://img.shields.io/maven-central/v/com.fasterxml.jackson.datatype/jackson-datatype-pcollections.svg)](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.jackson.datatype/jackson-datatype-pcollections/)
[![Javadoc](https://javadoc.io/badge/com.fasterxml.jackson.datatype/jackson-datatype-pcollections.svg)](https://www.javadoc.io/doc/com.fasterxml.jackson.datatype/jackson-datatype-pcollections)
[![Maven Central](https://img.shields.io/maven-central/v/tools.jackson.datatype/jackson-datatype-pcollections.svg)](https://maven-badges.herokuapp.com/maven-central/tools.jackson.datatype/jackson-datatype-pcollections/)
[![Javadoc](https://javadoc.io/badge/tools.jackson.datatype/jackson-datatype-pcollections.svg)](https://www.javadoc.io/doc/tools.jackson.datatype/jackson-datatype-pcollections)

## Usage

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

```xml
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<groupId>tools.jackson.datatype</groupId>
<artifactId>jackson-datatype-pcollections</artifactId>
<version>2.7.0</version>
<version>3.0.3</version>
</dependency>
```

Expand All @@ -30,8 +30,9 @@ To use module on Maven-based projects, use following dependency:
Like all standard Jackson modules (libraries that implement Module interface), registration is done as follows:

```java
ObjectMapper mapper = new ObjectMapper()
.registerModule(new PCollectionsModule());
ObjectMapper mapper = JsonMapper.builder()
.addModule(new PCollectionsModule())
.build();
```

after which functionality is available for all normal Jackson operations.
Expand Down