Update README.

Change-Id: I4f0fb8917bcc472a3d0c4f0bf4a5b9c9891ba777
2 files changed
tree: bc7e5d4212c5da2f660119d7fbdc488533aa8cc8
  1. .mvn/
  2. src/
  3. .gitignore
  4. COPYING
  5. COPYING.GPL
  6. pom.xml
  7. README.md
README.md

GVariant for Java

This library provides a GVariant parser in pure Java.

Overview

Instances of Decoder<T> 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.

Installation

Usage with Maven

<project>
  ...

  <dependencies>
    ...

    <dependency>
      <groupId>eu.mulk.jgvariant</groupId>
      <artifactId>jgvariant-core</artifactId>
      <version>0.1.0</version>
    </dependency>

    ...
  </dependencies>

  ...
</project>

Usage with Gradle

dependencies {
  ...

  implementation("eu.mulk.jgvariant:jgvariant-core:0.1.0")

  ...
}

Example

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));