ktav — Java bindings

Languages: English · Русский · 简体中文

Playground: convert JSON / YAML / TOML / INI ⇄ Ktav in your browser at ktav-lang.github.io.

Java bindings for the Ktav configuration format. Thin wrapper around the reference Rust parser, loaded at runtime through JNA — so no JNI build on the consumer side, plain Gradle/Maven just works.

Requires JDK 17+. Distributed via GitHub Releases for now (Maven Central publication is planned).

Quick start

build.gradle.kts:

repositories {
    mavenCentral()
    // while we're not yet on Maven Central, consume the JAR from
    // the GitHub Release — see the README for a worked example.
}

dependencies {
    implementation("io.github.ktav-lang:ktav:0.6.4")
    implementation("net.java.dev.jna:jna:5.15.0")
}

Parse — pull typed fields out of a document

import lang.ktav.Ktav;
import lang.ktav.Value;

String src = """
        service: web
        port: 8080
        ratio: 0.75
        tls: true
        tags: [
            prod
            eu-west-1
        ]
        db.host: primary.internal
        db.timeout: 30
        """;

Value.Obj top = (Value.Obj) Ktav.loads(src);

String  service = ((Value.Str)  top.entries().get("service")).value();
long    port    = ((Value.Int)  top.entries().get("port")).toLong();
double  ratio   = ((Value.Flt)  top.entries().get("ratio")).toDouble();
boolean tls     = ((Value.Bool) top.entries().get("tls")).value();

Value.Obj db    = (Value.Obj) top.entries().get("db");
String dbHost   = ((Value.Str) db.entries().get("host")).value();
long   dbTimeout = ((Value.Int) db.entries().get("timeout")).toLong();

Walk — dispatch on the sealed Value hierarchy

for (var e : top.entries().entrySet()) {
    if      (e.getValue() instanceof Value.Bool b) System.out.println(e.getKey() + " is bool=" + b.value());
    else if (e.getValue() instanceof Value.Int  i) System.out.println(e.getKey() + " is int=" + i.text());
    else if (e.getValue() instanceof Value.Arr  a) System.out.println(e.getKey() + " is array(" + a.items().size() + ")");
    // ...Null / Flt / Str / Obj
}

On JDK 21+ this becomes a switch expression on the sealed type pattern.

Build & render — construct a document in code

import java.util.LinkedHashMap;
import java.util.List;

LinkedHashMap<String, Value> upstream = new LinkedHashMap<>();
upstream.put("host", new Value.Str("a.example"));
upstream.put("port", Value.Int.of(1080));

LinkedHashMap<String, Value> doc = new LinkedHashMap<>();
doc.put("name",      new Value.Str("frontend"));
doc.put("port",      Value.Int.of(8443));
doc.put("tls",       Value.Bool.TRUE);
doc.put("ratio",     Value.Flt.of(0.95));
doc.put("upstreams", new Value.Arr(List.of(new Value.Obj(upstream))));
doc.put("notes",     Value.Null.NULL);

String text = Ktav.dumps(new Value.Obj(doc));
// name: frontend
// port: 8443
// tls: true
// ratio: 0.95
// upstreams: [
//     {
//         host: a.example
//         port: 1080
//     }
// ]
// notes: null

A complete runnable version lives in examples/basic.

API

Function	Purpose
Ktav.loads(String) -> Value	Parse a Ktav document into the {@link Value} tree.
Ktav.loadsStrict(String) -> Value	Parse with strict numeric spelling checks.
Ktav.dumps(Value) -> String	Render a Value back as Ktav text. Top-level must be an Obj.
Ktav.format(String) -> String	Normalise a document's spelling, keeping comments.
Ktav.nativeVersion() -> String	Version string reported by the loaded ktav_cabi.

Formatting

Ktav.format() takes Ktav source text and returns Ktav source text — it is not a Value renderer. It normalises structure to canonical form (§ 5.9) while keeping the trivia the canonical writer drops:

System.out.print(Ktav.format("## the server\nserver: {host: a, port: 80}\n"));
// ## the server
// server: {
//     host: a
//     port: 80
// }

Every comment survives verbatim — Ktav has no trailing comments (§ 3.4: a comment owns a whole line), so attachment is unambiguous. Blank lines survive as a grouping hint, but a run of two or more collapses to exactly one and blank padding just inside a bracket is dropped, which makes the transform a fixed point: formatting already-formatted text changes nothing. Key order is never changed — canonical form has no sorting rule, and reordering keys would make review diffs worse.

For a document with no comments and no blank lines the result equals Ktav.emitCanonical(Ktav.loads(src)). The stronger condition is deliberate: blank lines are no more part of the Value model than comments are, so the canonical writer drops them and format does not.

Errors

KtavException is thrown on any parse or render failure. Beyond a human-readable getMessage(), it carries the nine structured fields of the core's error envelope:

try {
    Ktav.loadsStrict("version: 1.10\n");
} catch (KtavException e) {
    e.getError();        // "LossyScalar"
    e.getLine();         // 1
    e.getLineText();     // "version: 1.10"
    e.getBody();         // "1.10"  — as written
    e.getCanonical();    // "1.1"   — as it would be stored
    e.getSpecSection();  // "§3.6/§5.2"
}

The full set is getError(), getReason(), getLine(), getLineText(), getSpanStart(), getSpanEnd(), getPath(), getBody(), getCanonical(), getSpecSection(). Absent information is null — the boxed Long return types exist for exactly that reason — never a missing accessor, so any field can be read without first checking the error class.

getPath() returns a List<String> of exact decoded key segments, never a joined string: a key literally named a.b is one segment and cannot be confused with a two-segment path.

Two writer rejections are named apart — "UnrepresentableAt" when the writer can say which node is at fault (it fills getPath() too), and "Unrepresentable" when it cannot. The reason code is the same in both, so matching on getReason() is enough when you only need to know that a write was refused.

Type mapping

Mirrors the Rust crate's Value enum — one variant per Ktav primitive, no lossy coercions:

Ktav	Value variant
null	Value.Null.NULL
true / false	Value.Bool
bare integer	Value.Int (text form — arbitrary precision, toBigInteger() / toLong())
bare decimal	Value.Flt (text form — exact round-trip, toDouble())
other scalar	Value.Str
[ ... ]	Value.Arr (List<Value>)
{ ... }	Value.Obj (LinkedHashMap<String, Value>, insertion order preserved)

Integers and floats are held as text so arbitrary precision (digits beyond long) and exact decimal round-trip are preserved byte for byte across parse/render cycles.

Key escaping

Since spec 0.6.4 a literal . or : inside a key segment is written with a backslash:

a\.b: v        // key is the single segment "a.b" -> { "a.b": "v" }
a\:b: v        // key contains a colon            -> { "a:b": "v" }
x.y\.z: v      // split on the first dot only     -> { "x": { "y.z": "v" } }

A literal backslash in a key is \\.

How the native library is resolved

At first call, the Java library resolves ktav_cabi in this order:

1. $KTAV_LIB_PATH — absolute path to a local build. Most useful for development and air-gapped CI.
2. User cache — <userCache>/ktav-java/v<version>/…, downloaded on a previous call.
3. GitHub Release download — the matching asset is fetched once from github.com/ktav-lang/java/releases/download/v<version>/<name> and cached under (2). Requires network on first call after install.

<userCache> is %LOCALAPPDATA% on Windows, ~/Library/Caches on macOS, $XDG_CACHE_HOME or ~/.cache on Linux.

Runtime support

• JDK 17+ (sealed interfaces).
• Prebuilt binaries for: linux/amd64, linux/arm64, darwin/amd64, darwin/arm64, windows/amd64, windows/arm64.
• Linux distros must use glibc 2.17+ (Rust's default target). Alpine (musl) support is planned.

License

MIT OR Apache-2.0 — see LICENSE-MIT and LICENSE-APACHE.

Other Ktav implementations

• spec — specification + conformance suite
• rust — reference Rust crate (cargo add ktav)
• csharp — C# / .NET (dotnet add package Ktav)
• golang — Go (go get github.com/ktav-lang/golang)
• js — JS / TS (npm install @ktav-lang/ktav)
• php — PHP (composer require ktav-lang/ktav)
• python — Python (pip install ktav)