MultipazProject

multipaz/org.multipaz.cbor/DataItem

DataItem

sealed class DataItem

Abstract base class for CBOR data items.

Instances of DataItem are immutable and implement the equals, hashCode, and toString methods.

To assist with parsing, a number of helper properties are included on this class to access the data using specific types. These include asBstr, asTstr, asNumber etc. for primitive types and also include higher-level types such as asCoseSign1 to get a CoseSign1.

CBOR maps and CBOR arrays can be accessed using the get method which is also available via the bracket operator. Note that get will throw if the requested key isn't available in the map. The hasKey, getOrDefault, or getOrNull methods can be used in situations where the key is optional.

Parameters

majorType

the CBOR major type of the data item.

Inheritors

IndefLengthBstr

IndefLengthTstr

Properties

val asArray: List<DataItem>

The value of a CborArray data item.

val asBoolean: Boolean

The value of a Simple data item containing either true/false.

val asBstr: ByteArray

The value of a Bstr data item.

val asCoseKey: CoseKey

The value of a data item containing a COSE_Key.

val asCoseLabel: CoseLabel

The value of a data item containing a COSE label (either number or string)

val asCoseMac0: CoseMac0

The value of a data item containing a COSE_Mac0.

val asCoseSign1: CoseSign1

The value of a data item containing a COSE_Sign1.

val asDateString: LocalDate

The date-time from a tstr with tag Tagged.FULL_DATE_STRING.

asDateTimeString

val asDateTimeString: Instant

The date-time from a tstr with tag Tagged.DATE_TIME_STRING.

val asDouble: Double

The value of a Double data item.

val asFloat: Float

The value of a Float data item.

val asMap: Map<DataItem, DataItem>

The value of a CborMap data item.

val asNumber: Long

The value of a Uint or Nint data item.

val asTagged: DataItem

The value of a Tagged data item.

asTaggedEncodedCbor

val asTaggedEncodedCbor: DataItem

The decoded CBOR from a bstr with tag Tagged.ENCODED_CBOR.

val asTstr: String

The value of a Tstr data item.

val asX509Cert: X509Cert

The value of a data item containing a certificate.

asX509CertChain

val asX509CertChain: X509CertChain

The value of a data item containing a certificate chain.

val majorType: MajorType

Functions

operator fun get(key: Long): DataItem

Gets the value of a key in a map or an index in an array

operator fun get(key: String): DataItem

operator fun get(key: DataItem): DataItem

Gets the value of a key in a map.

fun getOrDefault(key: Long, defaultValue: DataItem): DataItem

fun getOrDefault(key: String, defaultValue: DataItem): DataItem

fun getOrDefault(key: DataItem, defaultValue: DataItem): DataItem

Gets the value of a key in a map or a default value if the key doesn't exist.

fun getOrNull(key: Long): DataItem?

fun getOrNull(key: String): DataItem?

fun getOrNull(key: DataItem): DataItem?

Gets the value of a key in a map or null if the key doesn't exist.

fun hasKey(key: Long): Boolean

fun hasKey(key: String): Boolean

fun hasKey(key: DataItem): Boolean

Returns whether a map has a value for a given key