Skip to content

jvdsn/ioutil

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status Jitpack License

ioutil

This library provides various input and output utilities:

  • 8, 16, 32, 64 bit integers, signed and unsigned, big and little endian
  • 32 and 64 bit floating points
  • Arbitrary byte arrays
  • UTF-8, CESU-8 and Modified UTF-8 strings
  • Little Endian Base 128, signed and unsigned

Suggestions are always welcome!

Installation

Gradle

Step 1. Add the JitPack repository to your build file
Add it in your root build.gradle at the end of repositories:

    allprojects {
        repositories {
            ...
            maven { url 'https://jitpack.io' }
        }
    }

Step 2. Add the dependency

    dependencies {
            compile 'com.github.jvdsn:ioutil:[version]'
    }

Maven

Step 1. Add the JitPack repository to your build file

    <repositories>
        <repository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </repository>
    </repositories>

Step 2. Add the dependency

    <dependency>
        <groupId>com.github.jvdsn</groupId>
        <artifactId>ioutil</artifactId>
        <version>[version]</version>
    </dependency>

Documentation

The latest javadoc documentation can be found here: https://jitpack.io/com/github/jvdsn/ioutil/master-SNAPSHOT/javadoc/
Documentation for a specific version can be found at https://jitpack.io/com/github/jvdsn/ioutil/[version]/javadoc/

Usage

Reading from a byte array:

byte[] bytes = ...
Reader littleEndian = ByteArrayReader.littleEndian(bytes);
Reader bigEndian = ByteArrayReader.bigEndian(bytes);

Reading from an input stream:

InputStream inputStream = ...
Reader littleEndian = InputStreamReader.littleEndian(inputStream);
Reader bigEndian = InputStreamReader.bigEndian(inputStream);

Writing to a byte array:

byte[] bytes = ...
Writer littleEndian = ByteArrayWriter.littleEndian(bytes);
Writer bigEndian = ByteArrayWriter.bigEndian(bytes);

Writing to an output stream:

OutputStream outputStream = ...
Writer littleEndian = OutputStreamWriter.littleEndian(outputStream);
Writer bigEndian = OutputStreamWriter.bigEndian(outputStream);

Encoding or decoding UTF-8, CESU-8 and Modified UTF-8 strings:

String toEncode = ...
byte[] toDecode = ...
byte[] encodedUtf8 = StringEncoding.UTF_8.encode(toEncode);
String decodedUtf8 = StringEncoding.UTF_8.decode(toDecode);
byte[] encodedCesu8 = StringEncoding.CESU_8.encode(toEncode);
String decodedCesu8 = StringEncoding.CESU_8.decode(toDecode);
byte[] encodedMutf8 = StringEncoding.MUTF_8.encode(toEncode);
String decodedMutf8 = StringEncoding.MUTF_8.decode(toDecode);

Acknowledgements

YourKit

YourKit supports open source projects with its full-featured Java Profiler.
YourKit, LLC is the creator of YourKit Java Profiler and YourKit .NET Profiler, innovative and intelligent tools for profiling Java and .NET applications.

About

Java input and output utilities.

Resources

License

Stars

Watchers

Forks

Languages