| commit | aa29484fe74aa2954df35c35306562404043daa9 | [log] [tgz] |
|---|---|---|
| author | Matthias Andreas Benkard <code@mail.matthias.benkard.de> | Tue Dec 28 01:31:56 2021 +0100 |
| committer | Matthias Andreas Benkard <code@mail.matthias.benkard.de> | Tue Dec 28 01:31:56 2021 +0100 |
| tree | 830e9f4489e4ba10b62f8eddb3a7f017b64aa0ae | |
| parent | 329168c9f3b1e23f440f0c39fca421e1e226c391 [diff] |
README: Add module overview. Change-Id: I8c4701e8d4561940025165dd3beb448e3443de36
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.4</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.4")
implementation("eu.mulk.jgvariant:jgvariant-core")
implementation("eu.mulk.jgvariant:jgvariant-ostree")
...
}