SpaiR / byond-dmi-util

Set of util classes to work with BYOND dmi files. Deserialization and comparison included.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status Javadocs License

BYOND Dmi Util

About

Set of util classes to work with BYOND dmi files.

Installation

Maven Central JCenter

Library deployed to Maven Central and JCenter repositories.

pom.xml

<dependency>
    <groupId>io.github.spair</groupId>
    <artifactId>byond-dmi-util</artifactId>
    <version>${last.version}</version>
</dependency>

build.gradle:

compile 'io.github.spair:byond-dmi-util:${last.version}'

How To Use

DmiSlurper

Class used to deserialize .dmi file.

  • slurpUp(final File dmiFile) - from file.
  • slurpUp(final String dmiName, final String base64content) - from base64.
  • slurpUp(final String dmiName, final InputStream input) - from any input stream.

As a result of deserialization Dmi object returns.

DmiComparator

Class used to compare two dmi's and show difference between them.

  • compare(@Nullable final Dmi oldDmi, @Nullable final Dmi newDmi)

As a result of comparison DmiDiff object returns.

More could be found in JavaDoc.

About

Set of util classes to work with BYOND dmi files. Deserialization and comparison included.

License:MIT License


Languages

Language:Java 100.0%