* Note that QNameModule (and String in this context) encoding works similarly -- it can only occur as part of a * QName (coming from here or {@link MagnesiumPathArgument}) and is subject to the same memoization. * *
* For example, given two QNames {@code foo = QName.create("foo", "abc")} and * {@code bar = QName.create("foo", "def")}, if they are written in order {@code foo, bar, foo}, then the following * events are emitted: *
* QNAME (define QName, assign shorthand Q0)
* STRING_UTF "foo" ("foo", assign shorthand S0, implies define QNameModule, assign shorthand M0)
* STRING_EMPTY (foo's non-existent revision)
* STRING_UTF "abc" ("abc", assign shorthand S1)
* QNAME (define QName, assign shorthand Q1)
* MODREF_1B (byte)0 (reference M0)
* STRING_UTF "def" ("def", assign shorthand S2)
* QNAME_REF_1B (byte)0 (reference Q0)
*
*/
// Design note: STRING_EMPTY is required to *NOT* establish a shortcut, as that is less efficient (and hence does
// not make sense from the sender, the receiver or the serialization protocol itself.
static final byte QNAME = 0x16;
/**
* Reference a QName previously defined via {@link #QNAME}. Reference number is encoded as {@code unsigned byte}.
*/
static final byte QNAME_REF_1B = 0x17;
/**
* Reference a QName previously defined via {@link #QNAME}. Reference number is encoded as {@code unsigned short}.
*/
static final byte QNAME_REF_2B = 0x18;
/**
* Reference a QName previously defined via {@link #QNAME}. Reference number is encoded as {@code int}.
*/
static final byte QNAME_REF_4B = 0x19;
/**
* Reference a previously defined QNameModule. Reference number is encoded as {@code unsigned byte}.
*/
static final byte MODREF_1B = 0x1A;
/**
* Reference a previously defined QNameModule. Reference number is encoded as {@code unsigned short}.
*/
static final byte MODREF_2B = 0x1B;
/**
* Reference a previously defined QNameModule. Reference number is encoded as {@code int}.
*/
static final byte MODREF_4B = 0x1C;
/**
* A {@link BigDecimal}, encoded through {@link DataOutput#writeUTF(String)}.
*/
// This is legacy compatibility. At some point we will remove support for writing these.
static final byte BIGDECIMAL = 0x1D;
/**
* A {@link BigInteger}, encoded through {@link DataOutput#writeUTF(String)}.
*/
// This is legacy compatibility. At some point we will remove support for writing these.
static final byte BIGINTEGER = 0x1E;
// 0x1F reserved
/**
* Byte value {@code 0}.
*/
static final byte INT8_0 = 0x20;
/**
* Short value {@code 0}.
*/
static final byte INT16_0 = 0x21;
/**
* Integer value {@code 0}.
*/
static final byte INT32_0 = 0x22;
/**
* Long value {@code 0}.
*/
static final byte INT64_0 = 0x23;
/**
* {@link Uint8#ZERO} value.
*/
static final byte UINT8_0 = 0x24;
/**
* {@link Uint16#ZERO} value.
*/
static final byte UINT16_0 = 0x25;
/**
* {@link Uint32#ZERO} value.
*/
static final byte UINT32_0 = 0x26;
/**
* {@link Uint64#ZERO} value.
*/
static final byte UINT64_0 = 0x27;
/**
* Empty String value ({@code ""}).
*/
static final byte STRING_EMPTY = 0x28;
/**
* {@link #INT32} with a 2-byte operand.
*/
static final byte INT32_2B = 0x29;
/**
* {@link #UINT32} with a 2-byte operand.
*/
static final byte UINT32_2B = 0x2A;
/**
* {@link #INT64} with a 4-byte operand.
*/
static final byte INT64_4B = 0x2B;
/**
* {@link #UINT64} with a 4-byte operand.
*/
static final byte UINT64_4B = 0x2C;
// 0x2D - 0x39 reserved
/**
* Empty bits value. This code point starts the range, where the number of bits can be extracted as
* {@code code & 0x1F)}. Last three values of this range are used to encode more than 28 entries.
*/
static final byte BITS_0 = 0x40;
/**
* A bits value of up to 255 entries. Number of values is encoded as the following {@code unsigned byte}.
*/
static final byte BITS_1B = 0x5D;
/**
* A bits value of up to 65535 entries. Number of values is encoded as the following {@code unsigned short}.
*/
static final byte BITS_2B = 0x5E;
/**
* A bits value. Number of values is encoded as the following {@code int}.
*/
static final byte BITS_4B = 0x5F;
/**
* {@link YangInstanceIdentifier} with zero components. This code point starts the range ending with
* {@link #YIID_31}, where the number of components can be extracted as {@code code & 0x1F}. Identifiers with
* more than 31 components are encoded using {@link #YIID}.
*/
static final byte YIID_0 = 0x60;
/**
* {@link YangInstanceIdentifier} with 31 components. See {@link #YIID_0}.
*/
static final byte YIID_31 = 0x7F;
/**
* A {@code byte[]} with 0 bytes. This code point starts the range ending with {@link #BINARY_127}, where
* the number of bytes can be extracted as {@code code & 0x7F}. Arrays longer than 127 bytes are encoded using
* {@link #BINARY_1B}, {@link #BINARY_2B} and {@link #BINARY_4B} as needed.
*/
static final byte BINARY_0 = (byte) 0x80;
/**
* A {@code byte[]} with 127 bytes. See {@link #BINARY_0}.
*/
static final byte BINARY_127 = (byte) 0xFF;
private MagnesiumValue() {
}
}