com.apicatalog.cborld.CborLd Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of iridium-cbor-ld-jre8 Show documentation

A CBOR-based serialization for Linked Data

The newest version!

package com.apicatalog.cborld;

import com.apicatalog.cborld.decoder.Decoder;
import com.apicatalog.cborld.decoder.DecoderError;
import com.apicatalog.cborld.encoder.Encoder;
import com.apicatalog.cborld.encoder.EncoderError;
import com.apicatalog.cursor.jakarta.JakartaJsonCursor;

import jakarta.json.JsonObject;

/**
 * High level API to process CBOR-LD.
 */
public final class CborLd {

    public static final byte[] CBOR_LD_BYTE_PREFIX = new byte[] { (byte)0xD9, 0x05 };
    
    public static final byte UNCOMPRESSED = 0x00;
    public static final byte COMPRESSED_V1 =  0x01;

    /**
     * Encodes JSON-LD document as CBOR-LD document.
     * 
     * @param document JSON-LD document to encode 
     * @return a new {@link Encoder} instance allowing to encode the given document
     * 
     * @throws EncoderError
     */
    public static final Encoder encoder(JsonObject document) throws EncoderError {
        return Encoder.create(JakartaJsonCursor.from(document));
    }

    /**
     * Decodes CBOR-LD document as JSON-LD document.
     * 
     * @param document CBOR-LD document to decode
     * @return a new {@link Decoder} instance allowing to decode the given document
     * 
     * @throws DecoderError
     */
    public static final Decoder decoder(byte[] document) throws DecoderError {
        return Decoder.create(document);
    }
}