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 tag objects.

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

nnn(CBOR object )
0(ISO date string)
1(seconds[.mmm])
1010([CBOR text string, CBOR object ])

The purpose of the last construct 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. The CBOR tag must in this case be 1010. Example:

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

Note that the bignum 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.COTXObject	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 typeUrl, CBORObject object)	Creates a COTX-tagged object.

Method Summary

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

Methods inherited from class org.webpki.cbor.CBORObject

checkForUnread, clone, compareTo, encode, equals, getArray, getBigInteger, getBoolean, getBytes, getFloat16, getFloat32, getFloat64, getInt16, getInt32, getInt64, getInt8, getMap, getString, getTag, getUint16, getUint32, getUint64, getUint8, hashCode, isNull, scan, toDiagnosticNotation, 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 typeUrl,
 CBORObject object)

Creates a COTX-tagged object.

Parameters:

typeUrl - Type URL (or other string)

object - Object

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 GregorianCalendar 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:

GregorianCalendar

Throws:

CBORException

See Also:

• CBORObject.getDateTime()

getEpochTime

public GregorianCalendar 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:

GregorianCalendar

Throws:

CBORException

See Also:

• CBORObject.getEpochTime()

getCOTXObject

public CBORTag.COTXObject getCOTXObject()

Get COTX object.

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

Returns:

COTXObject

Throws:

CBORException

update

public CBORObject update(CBORObject object)

Update tagged CBOR object.

Parameters:

object - New object

Returns:

Previous object

Throws:

CBORException

getTagNumber

public long getTagNumber()

Get tag number.

Returns:

Tag number