| commit | 0239d32ac078c706d98b066ca4d49a8d91a404bc | [log] [tgz] |
|---|---|---|
| author | Matthias Andreas Benkard <code@mail.matthias.benkard.de> | Fri Apr 15 20:21:37 2022 +0200 |
| committer | Matthias Andreas Benkard <code@mail.matthias.benkard.de> | Fri Apr 15 20:21:37 2022 +0200 |
| tree | e65b17bf8820f51b02983896fedd17f5ea9d45b4 | |
| parent | 789a7fe484c6f3110e2e251ceab01dc7bb25ae94 [diff] |
Update Javadocs with @snippet blocks. Change-Id: Id28c226b6882c088f288b247f73041be807be862
This library provides a GVariant parser in pure Java.
jgvariant-core provides Decoder<T>, which read a given type of GVariant-encoded value from a ByteBuffer. The class also contains factory methods to acquire those instances.
The various subclasses of Decoder together implement the GVariant serialization specification.
jgvariant-ostree provides instances of Decoder<T> for various GVariant types used in OSTree repositories.
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(String s, int i) {}
var decoder =
Decoder.ofArray(
Decoder.ofStructure(
ExampleRecord.class,
Decoder.ofString(StandardCharsets.UTF_8),
Decoder.ofInt().withByteOrder(ByteOrder.LITTLE_ENDIAN)));
byte[] bytes = ...;
List<ExampleRecord> example = decoder.decode(ByteBuffer.wrap(bytes));
<project>
...
<dependencyManagement>
...
<dependencies>
<dependency>
<groupId>eu.mulk.jgvariant</groupId>
<artifactId>jgvariant-bom</artifactId>
<version>0.1.6</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
...
</dependencyManagement>
<dependencies>
...
<dependency>
<groupId>eu.mulk.jgvariant</groupId>
<artifactId>jgvariant-core</artifactId>
</dependency>
<dependency>
<groupId>eu.mulk.jgvariant</groupId>
<artifactId>jgvariant-ostree</artifactId>
</dependency>
...
</dependencies>
...
</project>
dependencies {
...
implementation(platform("eu.mulk.jgvariant:jgvariant-bom:0.1.6")
implementation("eu.mulk.jgvariant:jgvariant-core")
implementation("eu.mulk.jgvariant:jgvariant-ostree")
...
}