Package org.webpki.cbor

Class CBORTag

java.lang.Object

org.webpki.cbor.CBORObject

org.webpki.cbor.CBORTag

All Implemented Interfaces:

Cloneable, Comparable<CBORObject>

public class CBORTag
extends CBORObject

Class for holding CBOR #6.n (tag) objects.

Tagged objects are based on CBOR major type 6. This implementation accepts multiple variants of tags:

Type	Diagnostic Notation	Comment
General Purpose	nnn(CBOR object)	Arbitrary CBOR tag
Reserved DateTime	0(ISO date string)	See getDateTime()
Reserved EpochTime	1(Time stamp)	See getEpochTime()
Reserved COTX	1010([Text string, CBOR object])	See getCOTX()

The reserved tags are verified for correctness during decoding as well as when created programmatically.

Note that the bigint type is dealt with as a specific primitive, in spite of being a tagged object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CBORTag.COTX	Return object for COTX tags.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	RESERVED_TAG_COTX	COTX tag: 1010
static final int	RESERVED_TAG_DATE_TIME	DATE_TIME tag: 0
static final int	RESERVED_TAG_EPOCH_TIME	EPOCH_TIME tag: 1

Constructor Summary

Constructors

Constructor	Description
CBORTag(long tagNumber, CBORObject object)	Creates a CBOR tagged object.
CBORTag(String id, CBORObject object)	Creates a COTX object.

Method Summary

Modifier and Type	Method	Description
CBORObject	get()	Get tagged CBOR object.
CBORTag.COTX	getCOTX()	Get COTX object.
Instant	getDateTime()	Get ISO date/time object.
Instant	getEpochTime()	Get UNIX Epoch time object.
long	getTagNumber()	Get tag number.

Methods inherited from class org.webpki.cbor.CBORObject

checkForUnread, clone, compareTo, encode, encode, equals, getArray, getBigInteger, getBoolean, getBytes, getExtendedFloat64, getFloat16, getFloat32, getFloat64, getInt128, getInt16, getInt32, getInt53, getInt64, getInt8, getMap, getSimple, getString, getTag, getUint128, getUint16, getUint32, getUint64, getUint8, hashCode, isNull, scan, toDiagnostic, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

RESERVED_TAG_DATE_TIME

public static final int RESERVED_TAG_DATE_TIME

DATE_TIME tag: 0

See Also:

• Constant Field Values

RESERVED_TAG_EPOCH_TIME

public static final int RESERVED_TAG_EPOCH_TIME

EPOCH_TIME tag: 1

See Also:

• Constant Field Values

RESERVED_TAG_COTX

public static final int RESERVED_TAG_COTX

COTX tag: 1010

See Also:

• Constant Field Values

Constructor Details

CBORTag

public CBORTag(String id,
 CBORObject object)

Creates a COTX object.

The purpose of the COTX tag is to provide a generic way of adding an object type identifier in the form of a URL or other text data to CBOR objects. Example:

1010(["https://example.com/myobject", {
"amount": "145.00",
"currency": "USD"
}])

Parameters:

id - URL or other string serving as type id

object - Object

See Also:

• CBORTag.COTX

CBORTag

public CBORTag(long tagNumber,
 CBORObject object)

Creates a CBOR tagged object.

Parameters:

tagNumber - Tag number

object - Object

Throws:

CBORException

IllegalArgumentException

Method Details

get

public CBORObject get()

Get tagged CBOR object.

Returns:

object

getDateTime

public Instant getDateTime()

Get ISO date/time object.

This method assumes that a valid CBOR tag 0 has been found, otherwise a CBORException is thrown.

Overrides:

getDateTime in class CBORObject

Returns:

Instant

Throws:

CBORException

See Also:

• CBORObject.getDateTime()

getEpochTime

public Instant getEpochTime()

Get UNIX Epoch time object.

This method assumes that a valid CBOR tag 1 has been found, otherwise a CBORException is thrown.

Overrides:

getEpochTime in class CBORObject

Returns:

Instant

Throws:

CBORException

See Also:

• CBORObject.getEpochTime()

getCOTX

public CBORTag.COTX getCOTX()

Get COTX object.

This method assumes that a valid COTX tag has been found, otherwise a CBORException is thrown.

Returns:

COTX

Throws:

CBORException

See Also:

• CBORTag(String, CBORObject)

getTagNumber

public long getTagNumber()

Get tag number.

Returns:

Tag number