| commit | 05114647f0cd37fd09d344a088d5c57c4ac68a32 | [log] [tgz] | 
|---|---|---|
| author | Matthias Andreas Benkard <code@mail.matthias.benkard.de> | Wed Dec 29 21:51:29 2021 +0100 | 
| committer | Matthias Andreas Benkard <code@mail.matthias.benkard.de> | Wed Dec 29 21:51:29 2021 +0100 | 
| tree | dee633d2f1d9c478e04df35fd29fd874752db755 | |
| parent | 19d4af8b1dc1d3b5c74d09aef4dffbad096cdd71 [diff] | 
Properly document jgvariant-ostree. Change-Id: I0aa3b1df512ef99d0e25d73efdd34a1b488e7d0d
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")
  ...
}