co.nstant.in.cbor.model

Enum MajorType

java.lang.Object

java.lang.Enum<MajorType>

co.nstant.in.cbor.model.MajorType

All Implemented Interfaces:

Serializable, Comparable<MajorType>

public enum MajorType
extends Enum<MajorType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARRAY Major type 4: an array of data items.
BYTE_STRING Major type 2: a byte string.
MAP Major type 5: a map of pairs of data items.
NEGATIVE_INTEGER Major type 1: a negative integer.
SPECIAL Major type 7: floating point numbers and simple data types that need no content, as well as the "break" stop code.
TAG Major type 6: optional semantic tagging of other major types.
UNICODE_STRING Major type 3: string of Unicode characters that is encoded as UTF-8 [RFC3629].
UNSIGNED_INTEGER Major type 0: an unsigned integer.

Method Summary

Methods

Modifier and Type	Method and Description
int	getValue()
static MajorType	ofByte(int b)
static MajorType	valueOf(String name) Returns the enum constant of this type with the specified name.
static MajorType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNSIGNED_INTEGER

public static final MajorType UNSIGNED_INTEGER

Major type 0: an unsigned integer. The 5-bit additional information is either the integer itself (for additional information values 0 through 23), or the length of additional data. Additional information 24 means the value is represented in an additional uint8_t, 25 means a uint16_t, 26 means a uint32_t, and 27 means a uint64_t. For example, the integer 10 is denoted as the one byte 0b000_01010 (major type 0, additional information 10). The integer 500 would be 0b000_11001 (major type 0, additional information 25) followed by the two bytes 0x01f4, which is 500 in decimal.

NEGATIVE_INTEGER

public static final MajorType NEGATIVE_INTEGER

Major type 1: a negative integer. The encoding follows the rules for unsigned integers (major type 0), except that the value is then -1 minus the encoded unsigned integer. For example, the integer -500 would be 0b001_11001 (major type 1, additional information 25) followed by the two bytes 0x01f3, which is 499 in decimal.

BYTE_STRING

public static final MajorType BYTE_STRING

Major type 2: a byte string. The string's length in bytes is represented following the rules for positive integers (major type 0). For example, a byte string whose length is 5 would have an initial byte of 0b010_00101 (major type 2, additional information 5 for the length), followed by 5 bytes of binary content. A byte string whose length is 500 would have 3 initial bytes of 0b010_11001 (major type 2, additional information 25 to indicate a two-byte length) followed by the two bytes 0x01f4 for a length of 500, followed by 500 bytes of binary content.

UNICODE_STRING

public static final MajorType UNICODE_STRING

Major type 3: string of Unicode characters that is encoded as UTF-8 [RFC3629]. The format of this type is identical to that of byte strings (major type 2), that is, as with major type 2, the length gives the number of bytes. This type is provided for systems that need to interpret or display human-readable text. In contrast to formats such as JSON, the Unicode characters in this type are never escaped. Thus, a newline character (U+000A) is always represented in a string as the byte 0x0a, and never as the bytes 0x5c6e (the characters "\" and "n") or as 0x5c7530303061 (the characters "\", "u", "0", "0", "0", and "a").

ARRAY

public static final MajorType ARRAY

Major type 4: an array of data items. Arrays are also called lists, sequences, or tuples. The array's length follows the rules for byte strings (major type 2), except that the length denotes the number of data items, not the length in bytes that the array takes up. Items in an array do not need to all be of the same type. For example, an array that contains 10 items of any type would have an initial byte of 0b100_01010 (major type of 4, additional information of 10 for the length) followed by the 10 remaining items.

MAP

public static final MajorType MAP

Major type 5: a map of pairs of data items. Maps are also called tables, dictionaries, hashes, or objects (in JSON). A map is comprised of pairs of data items, the even-numbered ones serving as keys and the following odd-numbered ones serving as values for the key that comes immediately before it. The map's length follows the rules for byte strings (major type 2), except that the length denotes the number of pairs, not the length in bytes that the map takes up. For example, a map that contains 9 pairs would have an initial byte of 0b101_01001 (major type of 5, additional information of 9 for the number of pairs) followed by the 18 remaining items. The first item is the first key, the second item is the first value, the third item is the second key, and so on.

TAG

public static final MajorType TAG

Major type 6: optional semantic tagging of other major types. See Section 2.4.

SPECIAL

public static final MajorType SPECIAL

Major type 7: floating point numbers and simple data types that need no content, as well as the "break" stop code. See Section 2.3.

Method Detail

values

public static MajorType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MajorType c : MajorType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MajorType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

ofByte

public static MajorType ofByte(int b)