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

• Documentation
• JavaDoc

Maven Dependency

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

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

Usage

Encoding Examples

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();

byte[] encodedBytes = CborEncoder.encodeToBytes(
    new CborBuilder().add("text").add(1234).build());

byte[] encodedBytes = new UnsignedInteger(1234).encodeToBytes();

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
    }

});

Preserving order of map entries

By default, maps are encoded in canonical format. If you want to preserve the order of map entries, use the encoder in non-canonical mode:

ByteArrayOutputStream baos = new ByteArrayOutputStream();
new CborEncoder(baos).nonCanonical().encode(new CborBuilder()
    .addMap()
        .put(1, "v1")
        .put(0, "v2")
        .end()
    .build());
byte[] encodedBytes = baos.toByteArray();

Contribution Process

This project uses the C4 process for all code changes.

License

Copyright 2013-2023 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.