| commit | 4c32c3998476e12c34984d52253eaa4ae3bf6769 | [log] [tgz] |
|---|---|---|
| author | Matthias Andreas Benkard <code@mail.matthias.benkard.de> | Sun Dec 12 21:23:53 2021 +0100 |
| committer | Matthias Andreas Benkard <code@mail.matthias.benkard.de> | Sun Dec 12 21:23:53 2021 +0100 |
| tree | 62787608ad6caa5aef974d6a96da24cebbb21667 | |
| parent | 261532a25244be9562700aa95a91c1c71adb8405 [diff] |
Javadocs and README. Change-Id: I10d7cb87ca22475f3f73fb25acd813aa1f8d2bb8
This library provides a GVariant parser in pure Java.
The two foundational classes are Value and Decoder.
Value is a sum type (sealed interface) that represents a GVariant value. Its subtypes represent the different types of values that GVariant supports.
Instances of Decoder read a given concrete subtype of Value from a ByteBuffer. The class also contains factory methods to create those instances.
The various subclasses of Decoder together implement the GVariant serialization specification.
To parse a GVariant value of type "a(si)", which is an array of pairs of String and int, you can use the following code:
record ExampleRecord(Value.Str s, Value.Int32 i) {}
var decoder =
Decoder.ofArray(
Decoder.ofStructure(
ExampleRecord.class,
Decoder.ofStr(StandardCharsets.UTF_8),
Decoder.ofInt32().withByteOrder(ByteOrder.LITTLE_ENDIAN)));
byte[] bytes = ...;
Value.Array<Value.Structure<ExampleRecord>> example = decoder.decode(bytes);