Package org.xipki.util.cbor

Class CborType

  • public class CborType
extends java.lang.Object
    Represents the various major types in CBOR, along with their .

    The major type is encoded in the upper three bits of each initial byte. The lower 5 bytes represent any additional information.

    • Method Detail

      • getName

        public static java.lang.String getName​(int mt)
        Returns a descriptive string for the given major type.
        Parameters:
        mt - the major type to return as string, values from [0..7] are supported.
        Returns:
        the name of the given major type, as String, never null.
        Throws:
        java.lang.IllegalArgumentException - in case the given major type is not supported.

      • valueOf

        public static CborType valueOf​(int i)
        Decodes a given byte value to a CborType value.
        Parameters:
        i - the input byte (8-bit) to decode into a CborType instance.
        Returns:
        a CborType instance, never null.

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • getAdditionalInfo

        public int getAdditionalInfo()
        Returns:
        the additional information of this type, as integer value from [0..31].

      • getMajorType

        public int getMajorType()
        Returns:
        the major type, as integer value from [0..7].

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • isBreakAllowed

        public boolean isBreakAllowed()
        Returns:
        true if this type allows for an infinite-length payload, false if only definite-length payloads are allowed.

      • isEqualType

        public boolean isEqualType​(CborType other)
        Determines whether the major type of a given CborType equals the major type of this CborType.
        Parameters:
        other - the CborType to compare against, cannot be null.
        Returns:
        true if the given CborType is of the same major type as this CborType, false otherwise.
        Throws:
        java.lang.IllegalArgumentException - in case the given argument was null.

      • isEqualType

        public boolean isEqualType​(int encoded)
        Determines whether the major type of a given byte value (representing an encoded CborType) equals the major type of this CborType.
        Parameters:
        encoded - the encoded CBOR type to compare.
        Returns:
        true if the given byte value represents the same major type as this CborType, false otherwise.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object