Package ej.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)
                                throws java.lang.IllegalArgumentException
        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​(@Nullable
                      java.lang.Object obj)
        Description copied from class: java.lang.Object
        Indicates whether some other object is "equal to" this one.

        The equals method implements an equivalence relation on non-null object references:

        • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
        • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
        • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
        • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
        • For any non-null reference value x, x.equals(null) should return false.

        The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

        Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the reference object with which to compare.
        Returns:
        true if this object is the same as the obj argument; false otherwise.
        See Also:
        Object.hashCode(), HashMap

      • 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()
        Description copied from class: java.lang.Object
        Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

        The general contract of hashCode is:

        • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
        • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
        • It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

        As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a hash code value for this object.
        See Also:
        Object.equals(java.lang.Object), System.identityHashCode(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.

      • 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()
        Description copied from class: java.lang.Object
        Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

        The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: 

         getClass().getName() + '@' + Integer.toHexString(hashCode())
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of the object.