From 687836b2958820fd57aa3c79fe4ced11fb0f2332 Mon Sep 17 00:00:00 2001 From: Christian Basler Date: Sat, 11 Feb 2017 23:37:20 +0100 Subject: [PATCH] Removed files from messed up merge --- _config.yml | 1 - index.md | 80 ----------------------------------------------------- 2 files changed, 81 deletions(-) delete mode 100644 _config.yml delete mode 100644 index.md diff --git a/_config.yml b/_config.yml deleted file mode 100644 index fc24e7a..0000000 --- a/_config.yml +++ /dev/null @@ -1 +0,0 @@ -theme: jekyll-theme-hacker \ No newline at end of file diff --git a/index.md b/index.md deleted file mode 100644 index ea5719d..0000000 --- a/index.md +++ /dev/null @@ -1,80 +0,0 @@ -## Simple msgpack library for Java - -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/ch.dissem.msgpack/msgpack/badge.svg)](https://maven-badges.herokuapp.com/maven-central/ch.dissem.msgpack/msgpack) -[![Javadoc](https://javadoc-emblem.rhcloud.com/doc/ch.dissem.msgpack/msgpack/badge.svg)](http://www.javadoc.io/doc/ch.dissem.msgpack/msgpack) -[![Apache 2](https://img.shields.io/badge/license-Apache_2.0-blue.svg)](https://raw.githubusercontent.com/Dissem/Jabit/master/LICENSE) - -This is a simple Java library for handling MessagePack data. It doesn't do any object mapping, but maps to special -objects representing MessagePack types. To build, use command `./gradlew build`. - -For most cases you might be better off using `org.msgpack:msgpack`, but I found that I needed something that generically -represents the internal structure of the data. - -msgpack uses Semantic Versioning, meaning as long as the major version doesn't change, nothing should break if you -update. Be aware though that this doesn't necessarily applies for SNAPSHOT builds and the development branch. - - -#### Master -[![Build Status](https://travis-ci.org/Dissem/MsgPack.svg?branch=master)](https://travis-ci.org/Dissem/MsgPack) -[![Code Quality](https://img.shields.io/codacy/eb92c25247b4444383b163304e57a3ce/master.svg)](https://www.codacy.com/app/chrigu-meyer/MsgPack/dashboard?bid=4122049) -[![Test Coverage](https://codecov.io/github/Dissem/MsgPack/coverage.svg?branch=master)](https://codecov.io/github/Dissem/MsgPack?branch=master) - -#### Develop -[![Build Status](https://travis-ci.org/Dissem/MsgPack.svg?branch=develop)](https://travis-ci.org/Dissem/MsgPack?branch=develop) -[![Code Quality](https://img.shields.io/codacy/eb92c25247b4444383b163304e57a3ce/develop.svg)](https://www.codacy.com/app/chrigu-meyer/MsgPack/dashboard?bid=4118049) -[![Test Coverage](https://codecov.io/github/Dissem/MsgPack/coverage.svg?branch=develop)](https://codecov.io/github/Dissem/MsgPack?branch=develop) - -### Limitations - -* There is no fallback to BigInteger for large integer type numbers, so there might be an integer overflow when reading - too large numbers -* `MPFloat` uses the data type you're using to decide on precision (float 32 or 64) - not the actual value. E.g. 0.5 - could be saved perfectly as a float 42, but if you provide a double value, it will be stored as float 64, wasting - 4 bytes. - -### Setup - -Add msgpack as Gradle dependency: -```Gradle -compile "ch.dissem.msgpack:msgpack:1.0.0" -``` - -### Usage - -#### Serialize Data - -First, you'll need to create some msgpack objects to serialize: -```Java -MPMap> object = new MPMap<>(); -object.put(new MPString("compact"), new MPBoolean(true)); -object.put(new MPString("schema"), new MPInteger(0)); -``` -or the shorthand version for simple types: -```Java -import static ch.dissem.msgpack.types.Utils.mp; - -MPMap> object = new MPMap<>(); -object.put(mp("compact"), mp(true)); -object.put(mp("schema"), mp(0)); -``` -then just use `pack(OutputStream)`: -```Java -OutputStream out = ...; -object.pack(out); -``` - - -#### Deserialize Data - -For deserializing data there is the reader object: -```Java -Reader reader = Reader.getInstance() -``` -just use `reader.read(InputStream)`. Unfortunately you'll need to make sure you got what you expected, the following -example might result in `ClassCastException` at weird places: -```Java -InputStream in = ...; -MPType read = reader.read(in); -MPMap map = (MPMap) read; -String value = map.get(mp("key")).getValue(); -```