com.google.iot.cbor

Interface CborWriter

public interface CborWriter

Interface for serializing CborObject instances into CBOR-encoded data.

See Also:

CborReader

Method Summary

Modifier and Type	Method and Description
static CborWriter	createFromByteBuffer(ByteBuffer byteBuffer) Creates a CborWriter instance that writes to a ByteBuffer.
static CborWriter	createFromOutputStream(OutputStream outputStream) Creates a CborWriter instance that writes to an OutputStream.
static int	length(CborObject obj) Calculates the CBOR-encoded length of the given CborObject.
CborWriter	writeDataItem(CborObject obj) Serializes a CborObject.
CborWriter	writeTag(int tag) Serializes a CBOR tag.

Method Detail

createFromOutputStream

static CborWriter createFromOutputStream(OutputStream outputStream)

Creates a CborWriter instance that writes to an OutputStream.

createFromByteBuffer

static CborWriter createFromByteBuffer(ByteBuffer byteBuffer)

Creates a CborWriter instance that writes to a ByteBuffer.

length

static int length(CborObject obj)

Calculates the CBOR-encoded length of the given CborObject.

Parameters:

obj - the CborObject instance to determine the encoded length of

Returns:

the number of bytes required to serialize obj.

writeDataItem

@CanIgnoreReturnValue
CborWriter writeDataItem(CborObject obj)
                                        throws IOException

Serializes a CborObject.

Parameters:

obj - the CborObject to serialize

Returns:

an instance of this interface

Throws:

IOException - if there was a problem with the output mechanism

writeTag

@CanIgnoreReturnValue
CborWriter writeTag(int tag)
                                   throws IOException

Serializes a CBOR tag. This method is useful for prepending the tag CborTag.SELF_DESCRIBE_CBOR. The tag will be associated with the next object serialized with writeDataItem(com.google.iot.cbor.CborObject).

Parameters:

tag - the value of the tag to serialize

Returns:

an instance of this interface

Throws:

IOException - if there was a problem with the output mechanism