Skip to content

Commit dd7a327

Browse files
committed
Issue #23 SEO: update README title/intro; enrich POM names/descriptions (verify: grep 'java.util.json' in README and run 'mvn -q help:evaluate -Dexpression=project.description' per module)
1 parent b984b90 commit dd7a327

File tree

6 files changed

+18
-18
lines changed

6 files changed

+18
-18
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1-
# java.util.json Backport for JDK 21
1+
# java.util.json – Official JSON API Backport for Java 21
22

3-
Early access to the unstable `java.util.json` API — taken from the OpenJDK jdk-sandbox “json” branch as of 2025-09-04.
3+
Early access backport of the proposed `java.util.json` JDK API (from the OpenJDK jdk‑sandbox “json” branch) for use on Java 21+.
4+
This project provides the standard JSON API for Java ahead of time: immutable JSON value types, parsing utilities, and examples aligned with a potential future JEP.
5+
6+
References:
7+
- OpenJDK sandbox “json” branch: https://github.com/openjdk/jdk-sandbox/tree/master/src/java.json
8+
- Design paper: [Towards a JSON API for the JDK.pdf](Towards%20a%20JSON%20API%20for%20the%20JDK.pdf)
49

510
## Quick Start
611

@@ -43,7 +48,7 @@ JsonValue backToJson = Json.fromUntyped(Map.of(
4348
));
4449
```
4550

46-
## Back Port Project Goals
51+
## Backport Project Goals
4752

4853
- **✅Enable early adoption**: Let developers try the unstable Java JSON patterns today on JDK 21+
4954
- **✅API compatibility over performance**: Focus on matching the emerging "batteries included" API design rather than competing with existing JSON libraries on speed.
@@ -82,7 +87,7 @@ This is a simplified backport with the following changes from the original:
8287

8388
These vulnerabilities exist in the upstream OpenJDK sandbox implementation and are reported here for transparency.
8489

85-
## JSON Schema Validator
90+
## JSON Schema Validator (2020-12)
8691

8792
By including a basic schema validator that demonstrates how to build a realistic feature out of the core API. To demonstrate the power of the core API, it follows Data Oriented Programming principles: it parses JSON Schema into an immutable structure of records, then for validation it parses the JSON to the generic structure and uses the thread-safe parsed schema as the model to validate the JSON being checked.
8893

@@ -99,7 +104,7 @@ var result = schema.validate(
99104
// result.valid() => true
100105
```
101106

102-
Compatibility: we run the official 2020-12 JSON Schema Test Suite on verify; in strict mode it currently passes about 71% of applicable cases.
107+
Compatibility: runs the official 202012 JSON Schema Test Suite on `verify`; in strict mode it currently passes about 71% of applicable cases.
103108

104109
## Building
105110

json-compatibility-suite/pom.xml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,8 @@
1313
<artifactId>json-compatibility-suite</artifactId>
1414
<packaging>jar</packaging>
1515

16-
<name>java.util.json Java21 Backport JSONTestSuite</name>
17-
18-
<description>
19-
A module to run the official JSON Test Suite against the java.util.json backport for Java 21.
20-
</description>
16+
<name>java.util.json Java21 Backport – JSON Test Suite</name>
17+
<description>Runs the official JSON Test Suite against the java.util.json Java 21 backport to track conformance with JSON standards.</description>
2118

2219
<dependencies>
2320
<dependency>

json-java21-api-tracker/pom.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
<packaging>jar</packaging>
1515

1616
<name>java.util.json Java21 Backport Upstream API Tracker</name>
17+
<description>Compares the OpenJDK sandbox java.util.json API to this Java 21 backport and reports differences to maintain alignment with upstream.</description>
1718

1819
<properties>
1920
<maven.compiler.release>21</maven.compiler.release>

json-java21-schema/pom.xml

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,8 @@
1313

1414
<artifactId>java.util.json.schema</artifactId>
1515
<packaging>jar</packaging>
16-
<name>java.util.json Java21 Backport JSON Schema Validator</name>
17-
18-
<description>
19-
A JSON Schema validator implementation written with the experiment java.util.json API backport for Java 21.
20-
This module includes an integration test suite that runs the official JSON Schema Test Suite.
21-
</description>
16+
<name>java.util.json Java21 Backport – JSON Schema Validator (2020-12)</name>
17+
<description>Experimental JSON Schema 2020-12 validator built using the java.util.json Java 21 backport; includes integration tests running the official JSON Schema Test Suite.</description>
2218

2319
<properties>
2420
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

json-java21/pom.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313
<artifactId>java.util.json</artifactId>
1414
<packaging>jar</packaging>
1515

16-
<name>java.util.json Java21 Backport</name>
16+
<name>java.util.json Java21 Backport (Core)</name>
17+
<description>Backport of the OpenJDK sandbox java.util.json API for Java 21+. Immutable JSON value types and parsing utilities aligned with the future JDK standard library.</description>
1718

1819
<dependencies>
1920
<dependency>

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<packaging>pom</packaging>
1111

1212
<name>java.util.json Java21 Backport Parent</name>
13-
<description>A backport of the upcoming java.util.json API for Java 21+</description>
13+
<description>Backport of the OpenJDK sandbox java.util.json API for Java 21+. Provides immutable JSON value types and parsing utilities aligned with a potential future JDK JSON API.</description>
1414
<url>https://simbo1905.github.io/java.util.json.Java21/</url>
1515

1616
<licenses>

0 commit comments

Comments
 (0)