Package org.webpki.cbor

Class CBORObject

java.lang.Object
org.webpki.cbor.CBORObject
All Implemented Interfaces:
Cloneable, Comparable<CBORObject>
Direct Known Subclasses:
CBORArray, CBORBigInt, 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 [RFC 8949] term, "data item".

  • Method Details

    • encode

      public byte[] encode()
      Encode CBOR object.

      Note: this method always return CBOR data using Deterministic Encoding.

      See also CBORArray.encodeAsSequence().

      Returns:
      CBOR encoded byteArray

    • getBigInteger

      public BigInteger getBigInteger()
      Get CBOR bigint value.

      This method requires that the object is a CBORBigInt or CBORInt, otherwise a CBORException is thrown.

      Returns:
      BigInteger
      Throws:
      CBORException

    • getInt64

      public long getInt64()
      Get CBOR int value.

      This method requires that the object is a CBORInt and has a value ranging from -0x8000000000000000 to 0x7fffffffffffffff.

      Returns:
      long
      Throws:
      CBORException

    • getUint64

      public long getUint64()
      Get CBOR uint value.

      This method requires that the object is a CBORInt and has a value ranging from 0 to 0xffffffffffffffff.

      Returns:
      long
      Throws:
      CBORException

    • getInt32

      public int getInt32()
      Get CBOR int value.

      This method requires that the object is a CBORInt and has a value ranging from -0x80000000 to 0x7fffffff.

      Returns:
      int
      Throws:
      CBORException

    • getUint32

      public long getUint32()
      Get CBOR uint value.

      This method requires that the object is a CBORInt and has a value ranging from 0 to 0xffffffff.

      Returns:
      long
      Throws:
      CBORException

    • getInt16

      public int getInt16()
      Get CBOR int value.

      This method requires that the object is a CBORInt and has a value ranging from -0x8000 to 0x7fff.

      Returns:
      int
      Throws:
      CBORException

    • getUint16

      public int getUint16()
      Get CBOR uint value.

      This method requires that the object is a CBORInt and has a value ranging from 0 to 0xffff.

      Returns:
      int
      Throws:
      CBORException

    • getInt8

      public int getInt8()
      Get CBOR int value.

      This method requires that the object is a CBORInt and has a value ranging from -0x80 to 0x7f.

      Returns:
      int
      Throws:
      CBORException

    • getUint8

      public int getUint8()
      Get CBOR uint value.

      This method requires that the object is a CBORInt and has a value ranging from 0 to 0xff.

      Returns:
      int
      Throws:
      CBORException

    • getExtendedFloat64

      public double getExtendedFloat64()
      Get "extended" CBOR float64 value.

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

      This method requires that the object is a CBORFloat or a CBORNonFinite, otherwise a CBORException is thrown.

      Returns:
      double
      Throws:
      CBORException
      See Also:

    • getFloat64

      public double getFloat64()
      Get CBOR float64 value.

      This method requires that the object is a CBORFloat, otherwise 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 valid items. That is, the latter cause a CBORException to be thrown.

      Returns:
      double
      Throws:
      CBORException

    • getFloat32

      public float getFloat32()
      Get CBOR float32 value.

      This method requires that the object is a CBORFloat holding a 16 or 32-bit IEEE 754 value, otherwise a CBORException is thrown.

      Returns:
      float
      Throws:
      CBORException

    • getFloat16

      public float getFloat16()
      Get CBOR float16 value.

      This method requires that the object is a CBORFloat holding a 16-bit IEEE 754 value, otherwise a CBORException is thrown.

      Returns:
      float
      Throws:
      CBORException

    • getSimple

      public int getSimple()
      Get CBOR #7.n (simple) value.

      This method requires that the object is a CBORSimple, otherwise a CBORException is thrown.

      Returns:
      int
      Throws:
      CBORException

    • getBoolean

      public boolean getBoolean()
      Get CBOR bool value.

      This method requires that the object is a CBORBoolean, otherwise a CBORException is thrown.

      Returns:
      boolean
      Throws:
      CBORException

    • isNull

      public boolean isNull()
      Check for CBOR null.

      If the 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.

      This method requires that the object is a CBORString, otherwise a CBORException is thrown.

      Returns:
      String
      Throws:
      CBORException

    • getEpochTime

      public GregorianCalendar getEpochTime()
      Get UNIX Epoch time object.

      This method requires that the object is a CBORInt or CBORFloat, otherwise a CBORException is thrown.

      Returns:
      GregorianCalendar
      Throws:
      CBORException
      See Also:

    • getDateTime

      public GregorianCalendar getDateTime()
      Get ISO date/time object.

      This method requires that the object is a CBORString that is compatible with ISO date/time [RFC 3339], otherwise a CBORException is thrown.

      Returns:
      GregorianCalendar
      Throws:
      CBORException
      IllegalArgumentException
      See Also:

    • getBytes

      public byte[] getBytes()
      Get CBOR bstr object.

      This method requires that the object is a CBORBytes, otherwise a CBORException is thrown.

      Returns:
      byteArray
      Throws:
      CBORException

    • getMap

      public CBORMap getMap()
      Get CBOR map object.

      This method requires that the object is a CBORMap, otherwise a CBORException is thrown.

      Returns:
      CBOR map object
      Throws:
      CBORException

    • getArray

      public CBORArray getArray()
      Get CBOR array object.

      This method requires that the object is a CBORArray, otherwise a CBORException is thrown.

      Returns:
      CBOR array object
      Throws:
      CBORException

    • getTag

      public CBORTag getTag()
      Get CBOR tag object.

      This method requires that the object is a CBORTag, otherwise a CBORException is thrown.

      Returns:
      CBOR tag object
      Throws:
      CBORException

    • scan

      public CBORObject scan()
      Scan CBOR object and mark it as read.

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

      See also checkForUnread().
      Returns:
      this

    • 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.

      See also scan().
      Throws:
      CBORException

    • 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

    • toDiagnosticNotation

      public String toDiagnosticNotation(boolean prettyPrint)
      Render CBOR object in Diagnostic Notation.

      If the 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 toDiagnosticNotation(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