com.google.iot.cbor

Interface CborReader

public interface CborReader

Interface for parsing CBOR data into CborObject instances.

See Also:

CborWriter, CborObject.createFromCborByteArray(byte[]), CborObject.createFromCborByteArray(byte[], int, int)

Method Summary

Modifier and Type	Method and Description
long	bytesParsed() Gets the number of bytes that have been parsed by this instance.
static CborReader	createFromByteArray(byte[] bytes) Creates a CborReader instance from a byte array.
static CborReader	createFromByteArray(byte[] bytes, int offset) Creates a CborReader instance from a byte array with starting offset.
static CborReader	createFromByteArray(byte[] bytes, int offset, int objectCount) Creates a CborReader instance from a byte array with starting offset and a total object count.
static CborReader	createFromInputStream(InputStream inputStream) Creates a CborReader instance from an InputStream instance.
static CborReader	createFromInputStream(InputStream inputStream, int objectCount) Creates a CborReader instance from an InputStream instance with a total object count.
boolean	hasRemainingDataItems() Determines if there are additional data items to parse.
CborObject	readDataItem() Reads the next available data item as a CborObject.

Method Detail

createFromInputStream

static CborReader createFromInputStream(InputStream inputStream,
                                        int objectCount)

Creates a CborReader instance from an InputStream instance with a total object count.

Parameters:

inputStream - the InputStream to parse

objectCount - the number of top-level data items that will be generated

Returns:

a new CborReader instance

createFromInputStream

static CborReader createFromInputStream(InputStream inputStream)

Creates a CborReader instance from an InputStream instance.

Parameters:

inputStream - the InputStream to parse

Returns:

a new CborReader instance

createFromByteArray

static CborReader createFromByteArray(byte[] bytes,
                                      int offset,
                                      int objectCount)

Creates a CborReader instance from a byte array with starting offset and a total object count. The resulting CborReader will be configured to emit objectCount data items. If the input data does not contain objectCount objects, a CborParseException will be thrown from readDataItem()}.

Parameters:

bytes - the byte array to parse

offset - where in bytes to start parsing

objectCount - the number of top-level data items that will be generated

Returns:

a new CborReader instance

createFromByteArray

static CborReader createFromByteArray(byte[] bytes,
                                      int offset)

Creates a CborReader instance from a byte array with starting offset.

Parameters:

bytes - the byte array to parse

offset - where in bytes to start parsing

Returns:

a new CborReader instance

createFromByteArray

static CborReader createFromByteArray(byte[] bytes)

Creates a CborReader instance from a byte array.

Parameters:

bytes - the byte array to parse

Returns:

a new CborReader instance

hasRemainingDataItems

boolean hasRemainingDataItems()

Determines if there are additional data items to parse.

Returns:

true if there are additional data items which can be retrieved via readDataItem(), false otherwise.

readDataItem

CborObject readDataItem()
                 throws CborParseException,
                        IOException

Reads the next available data item as a CborObject. This method will block until an entire data item is read.

Returns:

the read data item

Throws:

CborParseException - if the data item was corrupted

IOException - if there was a problem with the underlying input mechanism

NoSuchElementException - if there are no more data items to be read

bytesParsed

long bytesParsed()

Gets the number of bytes that have been parsed by this instance.

Returns:

the number of parsed bytes