java.util.json – Backport from the OpenJDK sandbox

This is a backport of the java.util.json API from the OpenJDK jdk‑sandbox “json” branch for use on Java 21 and above.

References:

OpenJDK sandbox “json” branch: https://github.com/openjdk/jdk-sandbox/tree/json
Design paper: Towards a JSON API for the JDK.pdf

This project is not an official release; APIs and behaviour may change as upstream evolves. You can find this code on Maven Central.

This repo is organized into the following modules:

Module	What it is	JDK
`json-java21`	Core `java.util.json` backport (parser, immutable types, `Json` API)	21+
`json-java21-jtd`	JTD (RFC 8927) stack-machine interpreter — ideal for infrequent config parsing and one-time validation	21+
`json-java21-jtd-codegen`	Bytecode code generator for JTD schemas — ahead-of-time compiled validators for repeated hot-path validation	24+ (auto-skipped on JDK 21)
`jdt2jar`	CLI + distroless container to pre-compile JTD schemas into standalone validator JARs (eliminates JDK 24+ runtime requirement)	24+ (auto-skipped on JDK 21)
`json-java21-jsonpath`	JsonPath query engine over `jdk.sandbox.java.util.json` values (Goessner-style: filters, slices, recursive descent, unions)	21+
`json-compatibility-suite`	JSON Test Suite conformance reporter (tests against nst/JSONTestSuite)	21+
`json-java21-api-tracker`	Daily upstream API drift detector — fetches OpenJDK sandbox sources, compares public API signatures, reports differences	25+

We welcome contributions to the incubating modules.

Usage Examples

Running the Examples

To try the examples from this README, build the project and run the standalone example class:

./mvnw package
java -cp ./json-java21/target/test-classes/:./json-java21/target/classes/ jdk.sandbox.java.util.json.examples.ReadmeExamples

API Overview

The API provides immutable JSON value types:

JsonValue - Base type for all JSON values
JsonObject - JSON objects (key-value pairs)
JsonArray - JSON arrays
JsonString - JSON strings
JsonNumber - JSON numbers
JsonBoolean - JSON booleans (true/false)
JsonNull - JSON null

Parsing is done via the Json class:

JsonValue value = Json.parse(jsonString);

Parsing JSON to Maps and Objects

// Parse JSON string to generic structure
String json = "{\"name\":\"Alice\",\"age\":30,\"active\":true}";
JsonValue value = Json.parse(json);

// Access as map-like structure
JsonObject obj = (JsonObject) value;
String name = ((JsonString) obj.members().get("name")).string();
long age = ((JsonNumber) obj.members().get("age")).toLong();
boolean active = ((JsonBoolean) obj.members().get("active")).bool();

Simple Record Mapping

// Define records for structured data
record User(String name, long age, boolean active) {}

// Parse JSON directly to records
String userJson = "{\"name\":\"Bob\",\"age\":25,\"active\":false}";
JsonObject jsonObj = (JsonObject) Json.parse(userJson);

// Map to record
User user = new User(
    ((JsonString) jsonObj.members().get("name")).string(),
    ((JsonNumber) jsonObj.members().get("age")).toLong(),
    ((JsonBoolean) jsonObj.members().get("active")).bool()
);

// Convert records back to JSON using typed factories
JsonValue backToJson = JsonObject.of(Map.of(
    "name", JsonString.of(user.name()),
    "age", JsonNumber.of(user.age()),
    "active", JsonBoolean.of(user.active())
));

// Convert back to a JSON string
String jsonString = backToJson.toString();

Building JSON Programmatically

// Build JSON using typed factory methods
JsonObject data = JsonObject.of(Map.of(
    "name", JsonString.of("John"),
    "age", JsonNumber.of(30),
    "scores", JsonArray.of(List.of(
        JsonNumber.of(85),
        JsonNumber.of(92),
        JsonNumber.of(78)
    ))
));
String json = data.toString();

Extracting Values from JSON

// Extract values from parsed JSON
JsonValue parsed = Json.parse("{\"name\":\"John\",\"age\":30}");
JsonObject obj = (JsonObject) parsed;

// Use the new type-safe accessor methods
String name = obj.get("name").string();      // Returns "John"
long age = obj.get("age").toLong();          // Returns 30L
double ageDouble = obj.get("age").toDouble(); // Returns 30.0

The accessor methods on JsonValue:

string() - Returns the String value (for JsonString)
toLong() - Returns the long value (for JsonNumber, if representable)
toDouble() - Returns the double value (for JsonNumber, if representable)
bool() - Returns the boolean value (for JsonBoolean)
elements() - Returns List (for JsonArray)
members() - Returns Map<String, JsonValue> (for JsonObject)
get(String name) - Access JsonObject member by name
element(int index) - Access JsonArray element by index

Realistic Record Mapping

A powerful feature is mapping between Java records and JSON:

// Domain model using records
record User(String name, String email, boolean active) {}
record Team(String teamName, List<User> members) {}

// Create a team with users
Team team = new Team("Engineering", List.of(
    new User("Alice", "alice@example.com", true),
    new User("Bob", "bob@example.com", false)
));

// Convert records to JSON using typed factories
JsonValue teamJson = JsonObject.of(Map.of(
    "teamName", JsonString.of(team.teamName()),
    "members", JsonArray.of(team.members().stream()
        .map(u -> JsonObject.of(Map.of(
            "name", JsonString.of(u.name()),
            "email", JsonString.of(u.email()),
            "active", JsonBoolean.of(u.active())
        )))
        .toList())
));

// Parse JSON back to records
JsonObject parsed = (JsonObject) Json.parse(teamJson.toString());
Team reconstructed = new Team(
    ((JsonString) parsed.members().get("teamName")).string(),
    ((JsonArray) parsed.members().get("members")).elements().stream()
        .map(v -> {
            JsonObject member = (JsonObject) v;
            return new User(
                ((JsonString) member.members().get("name")).string(),
                ((JsonString) member.members().get("email")).string(),
                ((JsonBoolean) member.members().get("active")).bool()
            );
        })
        .toList()
);

Building Complex JSON

Create structured JSON programmatically:

// Building a REST API response
JsonObject response = JsonObject.of(Map.of(
    "status", JsonString.of("success"),
    "data", JsonObject.of(Map.of(
        "user", JsonObject.of(Map.of(
            "id", JsonNumber.of(12345),
            "name", JsonString.of("John Doe"),
            "roles", JsonArray.of(List.of(
                JsonString.of("admin"),
                JsonString.of("user")
            ))
        )),
        "timestamp", JsonNumber.of(System.currentTimeMillis())
    )),
    "errors", JsonArray.of(List.of())
));

Stream Processing

Process JSON arrays efficiently with Java streams:

// Filter active users from a JSON array
JsonArray users = (JsonArray) Json.parse(jsonArrayString);
List<String> activeUserEmails = users.elements().stream()
    .map(v -> (JsonObject) v)
    .filter(obj -> ((JsonBoolean) obj.members().get("active")).bool())
    .map(obj -> ((JsonString) obj.members().get("email")).string())
    .toList();

Error Handling

Handle parsing errors gracefully:

try {
    JsonValue value = Json.parse(userInput);
    // Process valid JSON
} catch (JsonParseException e) {
    // Handle malformed JSON with line/column information
    System.err.println("Invalid JSON at line " + e.getLine() + 
                       ", column " + e.getColumn() + ": " + e.getMessage());
}

Pretty Printing

Format JSON for display:

JsonObject data = JsonObject.of(Map.of(
    "name", JsonString.of("Alice"),
    "scores", JsonArray.of(List.of(
        JsonNumber.of(85),
        JsonNumber.of(90),
        JsonNumber.of(95)
    ))
));

String formatted = Json.toDisplayString(data, 2);
// Output:
// {
//   "name": "Alice",
//   "scores": [
//     85,
//     90,
//     95
//   ]
// }

JSON Test Suite Compatibility

This backport includes a compatibility report tool that tests against the JSON Test Suite to track conformance with JSON standards.

Running the Compatibility Report

The test data is bundled as ZIP files and extracted automatically at runtime:

# Run human-readable report
./mvnw exec:java -pl json-compatibility-suite

# Run JSON output (dogfoods the API)
./mvnw exec:java -pl json-compatibility-suite -Dexec.args="--json"

Backport Project Goals

✅Enable early adoption: Let developers try the unstable Java JSON patterns today on JDK 21+
✅API compatibility over performance: Focus on matching the emerging "batteries included" API design rather than competing with existing JSON libraries on speed.
✅Track upstream API: Match emerging API updates to be a potential "unofficial backport" if a final official solution ever lands.
✅Host Examples / Counter Examples: Only if there is community interest.

Non-Goals

🛑Performance competition: This backport is not intended to be the fastest JSON library. The JDK internal annotations that boost performance had to be removed.
🛑Feature additions: No features beyond what's in the experimental upstream branches. Contributions of example code or internal improvements are welcome.
🛑Production / API stability: Its an unstable API. It is currently only for educational or experimenal usage.
🛑Advoocacy / Counter Advocacy: This repo is not an endorsement of the proposed API nor a rejection of other solutions. Please only use the official Java email lists to debate the API or the general topic.

Current Status

Final java.util.json sandbox-era release (2026-05-19).

This code is derived from the OpenJDK jdk-sandbox repository "json" branch at commit c1a4f80 (2026-02-05), which was the last commit before the API was moved to jdk.incubator.json.

API Summary

JsonValue conversion methods: asBoolean(), toInt(), toLong(), toDouble(), asString()
JsonValue navigation methods: get(String), get(int), getOrAbsent(String), valueOrNull()
JsonArray: elements(), of(List)
JsonObject: members(), of(Map)
Json: parse(String), parse(char[]), toDisplayString(JsonValue, int)

Upstream Migration Notice

The upstream java.util.json API has been promoted to jdk.incubator.json (commit b956ae0, 2026-02-05). The incubator version introduces significant API changes including method renames (bool()→asBoolean(), string()→asString(), etc.) and new methods (asInt()). A separate branch tracks the incubator upgrade — see issue #145.

The original proposal and design rationale can be found in the included PDF: Towards a JSON API for the JDK.pdf

The JSON compatibitlity tests in this repo suggest 99% conformance with a leading test suite when in "strict" mode. The two conformance expecatations that fail assume that duplicated keys in a JSON document are okay. The upstream code at this time appear to take a strict stance that it should not siliently ignore duplicate keys in a json object.

CI: Upstream API Tracking

Note: The daily API tracker workflow currently targets the old java.util.json paths which no longer exist upstream. It needs to be updated to track jdk.incubator.json — see issue #145.

Modifications

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

Replaced LazyConstant with a package-local polyfill using double-checked locking pattern.
Added Utils.powExact() polyfill for Math.powExact(long, int) which is not available in Java 21.
Replaced unnamed variables _ with ignored for Java 21 compatibility.
Removed @ValueBased annotations.
Removed @PreviewFeature annotations.
Compatible with JDK 21.

Upstream Bug Fixes

The following fixes have been applied to address bugs in the upstream OpenJDK jdk-sandbox code. These are upstream issues that should be reported to the core-libs-dev@openjdk.org mailing list per OpenJDK process:

JsonNumber.of(double) offset bug (#118): The upstream implementation hardcodes decimalOffset=0 and exponentOffset=0, causing toLong() to fail for integral doubles like 123.0. Our fix delegates to JsonNumber.of(String) which correctly computes offsets via Json.parse().

Security Considerations

⚠️ This unstable API historically contained a undocumented security vulnerabilities. The compatibility test suite (documented below) includes crafted attack vectors that expose these issues:

Stack exhaustion attacks: Deeply nested JSON structures can trigger StackOverflowError, potentially leaving applications in an undefined state and enabling denial-of-service attacks
API contract violations: The Json.parse() method documentation only declares JsonParseException and NullPointerException, but malicious inputs can trigger undeclared exceptions

Such vulnerabilities existed at one point in the upstream OpenJDK sandbox implementation and were reported here for transparency. Until the upstream code is stable it is probably better to assume that such issue or similar may be present or may reappear. If you are only going to use this library in small cli programs where the json is configuration you write then you will not parse objects nested to tens of thousands of levels designed crash a parser. Yet you should not at this tiome expose this parser to the internet where someone can choose to attack it in that manner.

JSON Type Definition (JTD) Validator

This repo includes two JTD validation paths for different use cases:

Interpreter (json-java21-jtd) — stack-machine validator for infrequent config parsing and one-time validation. Runs on JDK 21+ with zero extra dependencies.
Bytecode codegen (json-java21-jtd-codegen) — generates dedicated validator classes for repeated hot-path validation (~9x faster). Requires JDK 24+ at build time; generated classes run on JDK 21+.

java.util.json has entered the JDK incubator (jdk.incubator.json). Once the API stabilises in the JDK itself, generated bytecode validators can depend directly on future JDK classes with zero library overhead.

Empty Schema `{}` Semantics (RFC 8927)

Per RFC 8927 (JSON Typedef), the empty schema {} is the empty form and accepts all JSON instances (null, boolean, numbers, strings, arrays, objects).

RFC 8927 §2.2 "Forms":
schema = empty / ref / type / enum / elements / properties / values / discriminator / definitions
empty = {}
Empty form: A schema in the empty form accepts all JSON values and produces no errors.

import json.java21.jtd.Jtd;
import jdk.sandbox.java.util.json.*;

JsonValue schema = Json.parse("{\"properties\":{\"name\":{\"type\":\"string\"}}}");
JsonValue data = Json.parse("{\"name\":\"Alice\"}");
Jtd validator = new Jtd();
Jtd.Result result = validator.validate(schema, data);
// result.isValid() => true

JTD RFC 8927 Compliance

✅ Eight mutually-exclusive schema forms (RFC 8927 §2.2)
✅ Standardized error format with instance and schema paths
✅ Primitive type validation with proper ranges
✅ Definition support with reference resolution
✅ Timestamp format validation (RFC 3339 with leap seconds)
✅ Discriminator tag exemption from additional properties
✅ Stack-based validation preventing StackOverflowError

JTD to JAR Compiler (Optional)

An optional jdt2jar CLI tool and distroless Docker image are available for pre-compiling JTD schemas into standalone validator JARs at build time. This eliminates the JDK 24+ runtime requirement for generated validators — the JARs run on JDK 21+.

See jdt2jar/README.md for build instructions, container usage, and the pre-built image on GitHub Container Registry (ghcr.io).

Building

Requires JDK 21 or later. Build with Maven:

./mvnw clean package

JsonPath

This repo also includes a JsonPath query engine (module json-java21-jsonpath), based on the original Goessner JSONPath article: https://goessner.net/articles/JsonPath/

import jdk.sandbox.java.util.json.*;
import json.java21.jsonpath.JsonPath;
import json.java21.jsonpath.JsonPathStreams;

JsonValue doc = Json.parse("""
  {"store": {"book": [
    {"author": "Nora Quill", "title": "Signal Lake", "price": 8.95},
    {"author": "Jae Moreno", "title": "Copper Atlas", "price": 12.99},
    {"author": "Marek Ilyin", "title": "Paper Comet", "price": 22.99}
  ]}}
  """);

var authors = JsonPath.parse("$.store.book[*].author")
    .query(doc)
    .stream()
    .map(JsonValue::string)
    .toList();

System.out.println("Authors count: " + authors.size());     // prints '3'
System.out.println("First author: " + authors.getFirst());  // prints 'Nora Quill'
System.out.println("Last author: " + authors.getLast());    // prints 'Marek Ilyin'

var cheapTitles = JsonPath.parse("$.store.book[?(@.price < 10)].title")
    .query(doc)
    .stream()
    .map(JsonValue::string)
    .toList();

var priceStats = JsonPath.parse("$.store.book[*].price")
    .query(doc)
    .stream()
    .filter(JsonPathStreams::isNumber)
    .mapToDouble(JsonPathStreams::asDouble)
    .summaryStatistics();

System.out.println("Total price: " + priceStats.getSum());
System.out.println("Min price: " + priceStats.getMin());
System.out.println("Max price: " + priceStats.getMax());
System.out.println("Avg price: " + priceStats.getAverage());

See json-java21-jsonpath/README.md for JsonPath operators and more examples.

Contributing

If you use an AI assistant while contributing, ensure it follows the contributor/agent workflow rules in AGENTS.md.

License

Licensed under the GNU General Public License version 2 with Classpath exception. See LICENSE for details.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

java.util.json – Backport from the OpenJDK sandbox

Usage Examples

Running the Examples

API Overview

Parsing JSON to Maps and Objects

Simple Record Mapping

Building JSON Programmatically

Extracting Values from JSON

Realistic Record Mapping

Building Complex JSON

Stream Processing

Error Handling

Pretty Printing

JSON Test Suite Compatibility

Running the Compatibility Report

Backport Project Goals

Non-Goals

Current Status

API Summary

Upstream Migration Notice

CI: Upstream API Tracking

Modifications

Upstream Bug Fixes

Security Considerations

JSON Type Definition (JTD) Validator

Empty Schema `{}` Semantics (RFC 8927)

JTD RFC 8927 Compliance

JTD to JAR Compiler (Optional)

Building

JsonPath

Contributing

License

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

java.util.json – Backport from the OpenJDK sandbox

Usage Examples

Running the Examples

API Overview

Parsing JSON to Maps and Objects

Simple Record Mapping

Building JSON Programmatically

Extracting Values from JSON

Realistic Record Mapping

Building Complex JSON

Stream Processing

Error Handling

Pretty Printing

JSON Test Suite Compatibility

Running the Compatibility Report

Backport Project Goals

Non-Goals

Current Status

API Summary

Upstream Migration Notice

CI: Upstream API Tracking

Modifications

Upstream Bug Fixes

Security Considerations

JSON Type Definition (JTD) Validator

Empty Schema {} Semantics (RFC 8927)

JTD RFC 8927 Compliance

JTD to JAR Compiler (Optional)

Building

JsonPath

Contributing

License

Empty Schema `{}` Semantics (RFC 8927)