commit	1464101c95fa32194243ad5e10e729b4f2b74066	[log] [tgz]
author	Constantin Rack <c-rack@users.noreply.github.com>	Sun Jun 07 12:29:16 2015 +0200
committer	Constantin Rack <c-rack@users.noreply.github.com>	Sun Jun 07 12:29:16 2015 +0200
tree	01db97b8599034be646f46692433d90a3c661b7a
parent	60813901159ab309cda47bdac4ebc09d562f65c1 [diff]

tree: 01db97b8599034be646f46692433d90a3c661b7a

README.md

cbor-java

A Java 7 implementation of RFC 7049: Concise Binary Object Representation (CBOR)

Features

Encodes and decodes all examples described in RFC 7049
Provides a fluent interface builder for CBOR messages
Supports semantic tags
Supports 64-bit integer values
Passes all CPD, PMD and FindBugs tests

Documentation

Maven Dependency

Add this to the dependencies section of your pom.xml file:

<dependency>
    <groupId>co.nstant.in</groupId>
    <artifactId>cbor</artifactId>
    <version>0.5</version>
</dependency>

Usage

Encoding Example

ByteArrayOutputStream baos = new ByteArrayOutputStream();
CborEncoder encoder = new CborEncoder(baos);
encoder.encode(new CborBuilder()
    .add("text")                // add string
    .add(1234)                  // add integer
    .add(new byte[] { 0x10 })   // add byte array
    .addArray()                 // add array
        .add(1)
        .add("text")
        .end()
    .build());
byte[] encodedBytes = baos.toByteArray();

Decoding Example

ByteArrayInputStream bais = new ByteArrayInputStream(encodedBytes);
CborDecoder decoder = new CborDecoder(bais);
List<DataItem> dataItems = decoder.decode();
for(DataItem dataItem : dataItems) {
    // process data item
}

Streaming Decoding Example

ByteArrayInputStream bais = new ByteArrayInputStream(encodedBytes);
CborDecoder decoder = new CborDecoder(bais);
decoder.decode(new DataItemListener() {

    @Override
    public void onDataItem(DataItem dataItem) {
        // process data item
    }

});

Contribution Process

This project uses the C4.1 process for all code changes.

"Everyone, without distinction or discrimination, SHALL have an equal right to become a Contributor under the terms of this contract."

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.