Package org.webpki.cbor

Class CBORObject

java.lang.Object

org.webpki.cbor.CBORObject

All Implemented Interfaces:

Cloneable, Comparable<CBORObject>

Direct Known Subclasses:

CBORArray, CBORBoolean, CBORBytes, CBORFloat, CBORInt, CBORMap, CBORNonFinite, CBORNull, CBORSimple, CBORString, CBORTag

public abstract class CBORObject
extends Object
implements Cloneable, Comparable<CBORObject>

Base class for all CBOR objects.

In this implementation "object" should be regarded as equivalent to the CBOR [RFC8949] term, "data item".

Method Summary

Modifier and Type	Method	Description
void	checkForUnread()	Check CBOR object for unread data.
CBORObject	clone()	Create deep copy of CBOR object.
int	compareTo(CBORObject object)	Compare CBOR objects for magnitude.
byte[]	encode()	Encode (aka "serialize") CBOR object.
OutputStream	encode(OutputStream outputStream)	Encode (aka "serialize") CBOR object to a stream.
boolean	equals(Object object)	Compare CBOR objects for equality.
CBORArray	getArray()	Get handle to CBOR [] (array) object.
BigInteger	getBigInteger()	Get CBOR integer object.
boolean	getBoolean()	Get CBOR bool object.
byte[]	getBytes()	Get CBOR bstr object.
Instant	getDateTime()	Get DateTime object.
Instant	getEpochTime()	Get EpochTime object.
double	getExtendedFloat64()	Get "extended" CBOR float object.
float	getFloat16()	Get CBOR float16 object.
float	getFloat32()	Get CBOR float32 object.
double	getFloat64()	Get CBOR float object.
BigInteger	getInt128()	Get CBOR int128 object.
int	getInt16()	Get CBOR int16 object.
int	getInt32()	Get CBOR int32 object.
long	getInt53()	Get CBOR int53 object.
long	getInt64()	Get CBOR int64 object.
int	getInt8()	Get CBOR int8 object.
CBORMap	getMap()	Get handle to CBOR {} (map) object.
int	getSimple()	Get CBOR #7.n (simple) object.
String	getString()	Get CBOR tstr object.
CBORTag	getTag()	Get handle to CBOR #6.n (tag) object.
BigInteger	getUint128()	Get CBOR uint128 object.
int	getUint16()	Get CBOR uint16 object.
long	getUint32()	Get CBOR uint32 object.
long	getUint64()	Get CBOR uint64 object.
int	getUint8()	Get CBOR uint8 object.
int	hashCode()	Calculate hash code of CBOR object.
boolean	isNull()	Check for CBOR null.
CBORObject	scan()	Scan CBOR object and mark it as read.
String	toDiagnostic(boolean prettyPrint)	Render CBOR object in Diagnostic Notation.
String	toString()	Render CBOR object in a pretty-printed form.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

encode

public OutputStream encode(OutputStream outputStream)

Encode (aka "serialize") CBOR object to a stream.

Note: this method always produce data using Deterministic Encoding.

Note: outputStream is not closed after the encoding has been performed.

Parameters:

outputStream - Where to write data

Returns:

The original outputStream

See Also:

• CBORArray.encodeAsSequence()

encode

public byte[] encode()

Encode (aka "serialize") CBOR object.

Note: this method always produce data using Deterministic Encoding.

Returns:

CBOR encoded byte-array

See Also:

• CBORArray.encodeAsSequence()

getBigInteger

public BigInteger getBigInteger()

Get CBOR integer object.

Get CBOR integers of any size.

If current object is not a CBORInt, a CBORException is thrown.

Returns:

BigInteger

Throws:

CBORException

See Also:

• CBORInt(BigInteger)

getInt128

public BigInteger getInt128()

Get CBOR int128 object.

If current object is not a CBORInt, or holds a value outside the range -0x80000000000000000000000000000000 to 0x7fffffffffffffffffffffffffffffff, a CBORException is thrown.

Returns:

128-bit signed integer.

Throws:

CBORException

See Also:

• CBORInt.createInt128(BigInteger)

getUint128

public BigInteger getUint128()

Get CBOR uint128 object.

If current object is not a CBORInt, or holds a value outside the range 0 to 0xffffffffffffffffffffffffffffffff, a CBORException is thrown.

Returns:

128-bit unsigned integer.

Throws:

CBORException

See Also:

• CBORInt.createUint128(BigInteger)

getInt64

public long getInt64()

Get CBOR int64 object.

If current object is not a CBORInt, or holds a value outside the range -0x8000000000000000 to 0x7fffffffffffffff, a CBORException is thrown.

Returns:

long

Throws:

CBORException

getUint64

public long getUint64()

Get CBOR uint64 object.

If current object is not a CBORInt, or holds a value outside the range 0 to 0xffffffffffffffff, a CBORException is thrown.

Returns:

long

Throws:

CBORException

getInt53

public long getInt53()

Get CBOR int53 object.

If current object is not a CBORInt, or holds a value outside the JavaScript limits Number.MIN_SAFE_INTEGER (-9007199254740991) to Number.MAX_SAFE_INTEGER (9007199254740991), a CBORException is thrown.

Since 53-bit integers are specific to JavaScript, int53 objects should be used with caution in cross-platform scenarios.

Returns:

long

Throws:

CBORException

See Also:

• CBORInt.createInt53(long)

getInt32

public int getInt32()

Get CBOR int32 object.

If current object is not a CBORInt, or holds a value outside the range -0x80000000 to 0x7fffffff, a CBORException is thrown.

Returns:

int

Throws:

CBORException

See Also:

• CBORInt.createInt32(long)

getUint32

public long getUint32()

Get CBOR uint32 object.

If current object is not a CBORInt, or holds a value outside the range 0 to 0xffffffff, a CBORException is thrown.

Returns:

long

Throws:

CBORException

See Also:

• CBORInt.createUint32(long)

getInt16

public int getInt16()

Get CBOR int16 object.

If current object is not a CBORInt, or holds a value outside the range -0x8000 to 0x7fff, a CBORException is thrown.

Returns:

int

Throws:

CBORException

See Also:

• CBORInt.createInt16(int)

getUint16

public int getUint16()

Get CBOR uint16 object.

If current object is not a CBORInt, or holds a value outside the range 0 to 0xffff, a CBORException is thrown.

Returns:

int

Throws:

CBORException

See Also:

• CBORInt.createUint16(int)

getInt8

public int getInt8()

Get CBOR int8 object.

If current object is not a CBORInt, or holds a value outside the range -0x80 to 0x7f, a CBORException is thrown.

Returns:

int

Throws:

CBORException

See Also:

• CBORInt.createInt8(int)

getUint8

public int getUint8()

Get CBOR uint8 object.

If current object is not a CBORInt, or holds a value outside the range 0 to 0xff, a CBORException is thrown.

Returns:

int

Throws:

CBORException

See Also:

• CBORInt.createUint8(int)

getExtendedFloat64

public double getExtendedFloat64()

Get "extended" CBOR float object.

If current object is not a CBORFloat holding a 64, 32, or 16-bit IEEE 754 number, a CBORException is thrown.

Note that unlike getFloat64(), this method also supports the Double.NaN, Double.POSITIVE_INFINITY, and Double.NEGATIVE_INFINITY non-finite variants.

Returns:

double

Throws:

CBORException

See Also:

• CBORFloat.createExtendedFloat(double)

getFloat64

public double getFloat64()

Get CBOR float object.

If current object is not a CBORFloat holding a 64, 32, or 16-bit IEEE 754 number, a CBORException is thrown.

Unlike getExtendedFloat64(), this method only accepts "regular" floating-point numbers. This makes it adapted for CBOR protocols that do not consider NaN or Infinity as valid items. That is, the latter cause a CBORException to be thrown.

Returns:

double

Throws:

CBORException

getFloat32

public float getFloat32()

Get CBOR float32 object.

If current object is not a CBORFloat holding a 32-bit or 16-bit IEEE 754 number, a CBORException is thrown.

Returns:

float

Throws:

CBORException

See Also:

• CBORFloat.createFloat32(double)

getFloat16

public float getFloat16()

Get CBOR float16 object.

If current object is not a CBORFloat holding a 16-bit IEEE 754 number, a CBORException is thrown.

Returns:

float

Throws:

CBORException

See Also:

• CBORFloat.createFloat16(double)

getSimple

public int getSimple()

Get CBOR #7.n (simple) object.

If current object is not a CBORSimple, a CBORException is thrown.

Returns:

int

Throws:

CBORException

getBoolean

public boolean getBoolean()

Get CBOR bool object.

If current object is not a CBORBoolean, a CBORException is thrown.

Returns:

boolean

Throws:

CBORException

isNull

public boolean isNull()

Check for CBOR null.

If current object is a CBORNull the call will return true, else it will return false.

Note that the object will only be considered as "read" (checkForUnread()) if the object is a CBORNull.

Returns:

boolean

getString

public String getString()

Get CBOR tstr object.

If current object is not a CBORString, a CBORException is thrown.

Returns:

String

Throws:

CBORException

getEpochTime

public Instant getEpochTime()

Get EpochTime object.

Depending on the type of the current object, this method performs a getInt64() or a getFloat64(). The returned number is subsequently used for initiating an Instant object.

If not all of the following conditions are met, a CBORException is thrown:

• The underlying object is a CBORInt or CBORFloat.
• The Epoch [TIME] object is within the range: 0 ("1970-01-01T00:00:00Z") to 253402300799 ("9999-12-31T23:59:59Z").

Returns:

Instant

Throws:

CBORException

See Also:

• CBORTag.getEpochTime()
• CBORUtil.createEpochTime(Instant, boolean)

getDateTime

public Instant getDateTime()

Get DateTime object.

This method performs a getString(). The returned string is subsequently used for initiating an Instant object.

If not all of the following conditions are met, a CBORException is thrown:

• The underlying object is a CBORString.
• The string matches the ISO date/time format described in section 5.6 of [RFC3339].
• The optional sub-second field (.nnn) features less than ten digits.
• The date/time object is within the range: "0000-01-01T00:00:00Z" to "9999-12-31T23:59:59Z".

Returns:

Instant

Throws:

CBORException

See Also:

• CBORTag.getDateTime()
• CBORUtil.createDateTime(Instant, boolean, boolean)

getBytes

public byte[] getBytes()

Get CBOR bstr object.

If current object is not a CBORBytes, a CBORException is thrown.

Returns:

byteArray

Throws:

CBORException

getMap

public CBORMap getMap()

Get handle to CBOR {} (map) object.

If current object is not a CBORMap, a CBORException is thrown.

Note: do not replace this method with a cast!

Returns:

CBOR {} (map) object

Throws:

CBORException

getArray

public CBORArray getArray()

Get handle to CBOR [] (array) object.

If current object is not a CBORArray, a CBORException is thrown.

Note: do not replace this method with a cast!

Returns:

CBOR [] (array) object

Throws:

CBORException

getTag

public CBORTag getTag()

Get handle to CBOR #6.n (tag) object.

If current object is not a CBORTag, a CBORException is thrown.

Note: do not replace this method with a cast!

Returns:

CBOR #6.n (tag) object

Throws:

CBORException

scan

public CBORObject scan()

Scan CBOR object and mark it as read.

This method sets the status of the current object as well as to possible child objects to "read".

Returns:

this

See Also:

• checkForUnread()

checkForUnread

public void checkForUnread()

Check CBOR object for unread data.

Verifies that all objects from the current object including possible child objects have been read (through calling getBytes() etc.), and throws a CBORException if this is not the case.

Throws:

CBORException

See Also:

• scan()

equals

public boolean equals(Object object)

Compare CBOR objects for equality.

The result is true if and only if the argument is not null and is a CBORObject, and the associated binary encodings (as provided by encode()) are equivalent.

Overrides:

equals in class Object

Parameters:

object - Argument to compare with

compareTo

public int compareTo(CBORObject object)

Compare CBOR objects for magnitude.

The comparison is based on the associated binary encodings as provided by encode().

Specified by:

compareTo in interface Comparable<CBORObject>

Parameters:

object - Argument to compare with

hashCode

public int hashCode()

Calculate hash code of CBOR object.

The hash is calculated in the same way as for String.hashCode(), using the output from encode() as "s".

Overrides:

hashCode in class Object

toDiagnostic

public String toDiagnostic(boolean prettyPrint)

Render CBOR object in Diagnostic Notation.

If current object (as well as possible child objects), conforms to the subset of data types supported by JSON, this method can also be used to generate JSON data.

Parameters:

prettyPrint - If true white space is added to make the result easier to read. If false elements are output without additional white space (=single line).

toString

public String toString()

Render CBOR object in a pretty-printed form.

Equivalent to toDiagnostic(boolean) with the argument set to true.

Overrides:

toString in class Object

clone

public CBORObject clone()

Create deep copy of CBOR object.

Note that the copy is assumed to be "unread" (checkForUnread()).

Overrides:

clone in class Object