Skip to content

Commit a2e4325

Browse files
committed
Update project name and README to reflect java.util.json backport vision
1 parent e13b294 commit a2e4325

File tree

2 files changed

+23
-6
lines changed

2 files changed

+23
-6
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,30 @@
1-
# JSON Experimental - JDK 21+ Backport
1+
# java.util.json Backport for JDK 21+
22

3-
This repository contains a backport of the experimental JSON API from the [jdk-sandbox project](https://github.com/openjdk/jdk-sandbox) to JDK 21 and later.
3+
Early access to the future `java.util.json` API - tracking OpenJDK sandbox development.
44

5-
## Origin
5+
## Project Vision
66

7-
This code is derived from the official OpenJDK sandbox repository at commit [d22dc2ba89789041c3908cdaafadc1dcf8882ebf](https://github.com/openjdk/jdk-sandbox/commit/d22dc2ba89789041c3908cdaafadc1dcf8882ebf) ("Improve hash code spec wording").
7+
This project provides Java developers with early access to the future `java.util.json` API patterns today, allowing code written against this API to migrate seamlessly when the official API is released. Rather than adopting third-party JSON libraries that will never align with future JDK standards, developers can start using tomorrow's API patterns today.
8+
9+
## Current Status
10+
11+
This code is derived from the official OpenJDK sandbox repository at commit [d22dc2ba89789041c3908cdaafadc1dcf8882ebf](https://github.com/openjdk/jdk-sandbox/commit/d22dc2ba89789041c3908cdaafadc1dcf8882ebf) (3 days ago - "Improve hash code spec wording").
812

913
The original proposal and design rationale can be found in the included PDF: [Towards a JSON API for the JDK.pdf](Towards%20a%20JSON%20API%20for%20the%20JDK.pdf)
1014

15+
## Project Goals
16+
17+
- **Enable early adoption**: Let developers use future Java JSON patterns today on JDK 21+
18+
- **Smooth migration path**: Code written against this API should require minimal changes when migrating to the official release
19+
- **API compatibility over performance**: Focus on matching the API design rather than competing with existing JSON libraries on speed
20+
21+
## Non-Goals
22+
23+
- **Performance competition**: This is not intended to be the fastest JSON library
24+
- **Feature additions**: No features beyond what's in the official sandbox/preview
25+
- **Production optimization**: The official implementation will have JVM-level optimizations unavailable to a backport
26+
- **API stability**: This backport may evolve as the official specification develops (if folks find it useful)
27+
1128
## Modifications
1229

1330
This is a simplified backport with the following changes from the original:

pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
<version>1.0-SNAPSHOT</version>
88
<packaging>jar</packaging>
99

10-
<name>JSON Experimental</name>
11-
<description>Experimental JSON API and internal dependencies</description>
10+
<name>java.util.json Backport for JDK 21+</name>
11+
<description>Early access to future java.util.json API - tracking OpenJDK sandbox development</description>
1212

1313
<licenses>
1414
<license>

0 commit comments

Comments
 (0)