DOC

io.github.markrileybot : heatshrink-java

Maven & Gradle

Oct 19, 2022
9 stars

heatshrink-java · # heatshrink-java Java library used to encode/decode [heatshrink](https://github.com/atomicobject/heatshrink) compressed data. ## Building ```bash ./gradlew build ``` ## Gradle dependency See https://search.maven.org/artifact/io.github.markrileybot/heatshrink-java/ ## Usage ### Java library ```java int windowSize = 9; int lookaheadSize = 8; ByteArrayOutputStream baos = new ByteArrayOutputStream(); try(HsOutputStream out = new HsOutputStream(baos, windowSize, lookaheadSize)) { out.write("ABCABCABCABCABCABC".getBytes()); } try(HsInputStream hsi = new HsInputStream(new ByteArrayInutStream(baos.toByteArray()), windowSize, lookaheadSize)) { byte[] res = new byte[512]; int len = hsi.read(res); System.out.println(new String(res, 0, len)); } ``` ### CLI ```bash $ java -jar heatshrink-java-exe.jar [-h] [-e|-d] [-v] [-w SIZE] [-l BITS] [IN_FILE] [OUT_FILE] ``` ## Status [![Build Status](https://github.com/markrileybot/heatshrink-java/actions/workflows/gradle-publish.yml/badge.svg)](https://github.com/markrileybot/heatshrink-java/actions/workflows/gradle-publish.yml) [![Coverage Status](https://coveralls.io/repos/github/markrileybot/heatshrink-java/badge.svg?branch=master)](https://coveralls.io/github/markrileybot/heatshrink-java?branch=master) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.markrileybot/geokey/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.markrileybot/geokey)

Table Of Contents

Latest Version

Download io.github.markrileybot : heatshrink-java Javadoc & API Documentation - Latest Versions:

All Versions

Download io.github.markrileybot : heatshrink-java Javadoc & API Documentation - All Versions:

Version Size Javadoc Updated
1.0.x

How to open Javadoc JAR file in web browser

  1. Rename the file heatshrink-java-1.0.1-javadoc.jar to heatshrink-java-1.0.1-javadoc.zip
  2. Use your favourite unzip tool (WinRAR / WinZIP) to extract it, now you have a folder heatshrink-java-1.0.1-javadoc
  3. Double click index.html will open the index page on your default web browser.

How to generate Javadoc from a source JAR?

Running the command javadoc:

javadoc --ignore-source-errors -encoding UTF-8 -sourcepath "heatshrink-java-1.0.1-sources.jar" -d "heatshrink-java-1.0.1-javadoc" -subpackages