commit	d50ec0182032f5e942d14087aed4a26fc8469f13	[log] [tgz]
author	Xin Li <[email protected]>	Tue Jun 18 14:13:25 2024 -0700
committer	Xin Li <[email protected]>	Tue Jun 18 14:13:25 2024 -0700
tree	bfe5fef83bf9ea322f8ac511d06ee3f809a339eb
parent	3bcaeafe943411543f051b8142b62ffe45589356 [diff]
parent	d306bdc96badcb44b5d76f068c3a38064c242759 [diff]

tree: bfe5fef83bf9ea322f8ac511d06ee3f809a339eb

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.8</version>
</dependency>

Usage

Encoding Example

ByteArrayOutputStream baos = new ByteArrayOutputStream();
new CborEncoder(baos).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);
List<DataItem> dataItems = new CborDecoder(bais).decode();
for(DataItem dataItem : dataItems) {
    // process data item
}

Streaming Decoding Example

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

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

});

Contribution Process

This project uses the C4 process for all code changes.

License

Copyright 2013-2017 Constantin Rack

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.