BinaryWireCode (OpenHFT/Chronicle-Wire 2.26ea3 API)

java.lang.Object
- java.lang.Enum<BinaryWireCode>
- - net.openhft.chronicle.wire.BinaryWireCode

All Implemented Interfaces:

Serializable, Comparable<BinaryWireCode>
```
public enum BinaryWireCode
extends Enum<BinaryWireCode>
```
Enumerates the predefined byte codes for the Binary YAML wire format. Each constant in this class provides a specific purpose when working with the wire format, enabling efficient serialization and deserialization processes.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ANCHOR` Indicates a general anchor point within the serialized structure.
`static int`	`BYTES_LENGTH16` Sequence length 0 to 2^16-1 bytes.
`static int`	`BYTES_LENGTH32` Sequence length 0 to 2^32-1 bytes.
`static int`	`BYTES_LENGTH8` Sequence length 0 to 255 bytes.
`static int`	`BYTES_MARSHALLABLE` Deprecated.
`static int`	`COMMENT` Marks a comment, not intended for parsing as part of the data structure.
`static int`	`DATE` Represents a date value.
`static int`	`DATE_TIME` Represents a date-time value.
`static int`	`EVENT_NAME` A field of any length, marked as an event name.
`static int`	`EVENT_OBJECT` Indicates an event object instead of the typical string.
`static int`	`FALSE` boolean value representing 'false'.
`static int`	`FIELD_ANCHOR` Indicates a field anchor point within the serialized structure.
`static int`	`FIELD_NAME_ANY` A field name of any length.
`static int`	`FIELD_NAME0` Starting code for predefined field names of length 0, 1, 2 ...
`static int`	`FIELD_NAME31` Ending code for predefined field names.
`static int`	`FIELD_NUMBER` Represents a numerical field number instead of a name.
`static int`	`FLOAT_SET_LOW_0` Floating-point number rounded to the nearest whole number.
`static int`	`FLOAT_SET_LOW_2` Floating-point number rounded to 2 decimal places for compact storage.
`static int`	`FLOAT_SET_LOW_4` Floating-point number rounded to 4 decimal places for compact storage.
`static int`	`FLOAT_STOP_2` Floating-point number with 2 decimal places optimized for storage.
`static int`	`FLOAT_STOP_4` Floating-point number with 4 decimal places optimized for storage.
`static int`	`FLOAT_STOP_6` Floating-point number with 6 decimal places optimized for storage.
`static int`	`FLOAT32` Represents a 32-bit floating-point number.
`static int`	`FLOAT64` Represents a 64-bit floating-point number (double precision).
`static int`	`HINT` Provides a hint for serialization or deserialization processes, possibly affecting how data is interpreted.
`static int`	`HISTORY_MESSAGE` Indicates a HistoryMessage follows.
`static int`	`I64_ARRAY` Array of 64-bit integers.
`static int`	`INT16` Signed 16-bit integer (short).
`static int`	`INT32` Signed 32-bit integer.
`static int`	`INT64` Signed 64-bit integer (long).
`static int`	`INT64_0x` 64-bit integer to be displaying in hexadecimal format.
`static int`	`INT8` Signed 8-bit integer (byte).
`static int`	`NULL` Code representing a null value in the serialized data.
`static int`	`PADDING` Single byte padding to ensure alignment.
`static int`	`PADDING32` padding with a 32-bit length to ensure alignment.
`static int`	`SET_LOW_INT16` 16-bit integer with optimized storage for low positive values.
`static int`	`SET_LOW_INT8` 8-bit integer with optimized storage for low positive values.
`static int`	`STRING_0` Starting code for compact string representation of length 0, 1, 2 ...
`static int`	`STRING_31` Ending code for compact string representation.
`static int`	`STRING_ANY` A String of any length
`static String[]`	`STRING_FOR_CODE` Array storing the string representations for each binary wire code, facilitating easier debugging and logging.
`static int`	`TIME` Represents a time value.
`static int`	`TRUE` boolean value representing 'true'.
`static int`	`TYPE_LITERAL` Represents a type literal.
`static int`	`TYPE_PREFIX` Prefix indicating the type of the following serialized object.
`static int`	`U8_ARRAY` Array of unsigned bytes.
`static int`	`UINT16` Unsigned 16-bit integer (short).
`static int`	`UINT32` Unsigned 32-bit integer.
`static int`	`UINT8` Unsigned 8-bit integer (byte).
`static int`	`UPDATED_ALIAS` Denotes an updated alias value.
`static int`	`UUID` Represents a universally unique identifier (UUID).
`static int`	`ZONED_DATE_TIME` Represents a zoned date-time value.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`isFieldCode(int code)` Determines if the provided code corresponds to a field name.
`static @NotNull String`	`stringForCode(int code)` Retrieves the string representation of a binary wire code.
`static BinaryWireCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static BinaryWireCode[]`	`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

- Field Detail
  - BYTES_LENGTH8
```
public static final int BYTES_LENGTH8
```
    Sequence length 0 to 255 bytes.
    
    See Also:
    
    Constant Field Values
  - BYTES_LENGTH16
```
public static final int BYTES_LENGTH16
```
    Sequence length 0 to 2^16-1 bytes.
    
    See Also:
    
    Constant Field Values
  - BYTES_LENGTH32
```
public static final int BYTES_LENGTH32
```
    Sequence length 0 to 2^32-1 bytes.
    
    See Also:
    
    Constant Field Values
  - BYTES_MARSHALLABLE
```
@Deprecated
public static final int BYTES_MARSHALLABLE
```
    Deprecated.
    
    Explicitly indicates BytesMarshallable sequences.
    
    See Also:
    
    Constant Field Values
  - HISTORY_MESSAGE
```
public static final int HISTORY_MESSAGE
```
    Indicates a HistoryMessage follows. was BYTES_MARSHALLABLE, but only used for this purpose
    
    See Also:
    
    Constant Field Values
  - FIELD_ANCHOR
```
public static final int FIELD_ANCHOR
```
    Indicates a field anchor point within the serialized structure.
    
    See Also:
    
    Constant Field Values
  - ANCHOR
```
public static final int ANCHOR
```
    Indicates a general anchor point within the serialized structure.
    
    See Also:
    
    Constant Field Values
  - UPDATED_ALIAS
```
public static final int UPDATED_ALIAS
```
    Denotes an updated alias value.
    
    See Also:
    
    Constant Field Values
  - U8_ARRAY
```
public static final int U8_ARRAY
```
    Array of unsigned bytes.
    
    See Also:
    
    Constant Field Values
  - I64_ARRAY
```
public static final int I64_ARRAY
```
    Array of 64-bit integers.
    
    See Also:
    
    Constant Field Values
  - PADDING32
```
public static final int PADDING32
```
    padding with a 32-bit length to ensure alignment.
    
    See Also:
    
    Constant Field Values
  - PADDING
```
public static final int PADDING
```
    Single byte padding to ensure alignment.
    
    See Also:
    
    Constant Field Values
  - FLOAT32
```
public static final int FLOAT32
```
    Represents a 32-bit floating-point number.
    
    See Also:
    
    Constant Field Values
  - FLOAT64
```
public static final int FLOAT64
```
    Represents a 64-bit floating-point number (double precision).
    
    See Also:
    
    Constant Field Values
  - FLOAT_STOP_2
```
public static final int FLOAT_STOP_2
```
    Floating-point number with 2 decimal places optimized for storage.
    
    See Also:
    
    Constant Field Values
  - FLOAT_STOP_4
```
public static final int FLOAT_STOP_4
```
    Floating-point number with 4 decimal places optimized for storage.
    
    See Also:
    
    Constant Field Values
  - FLOAT_STOP_6
```
public static final int FLOAT_STOP_6
```
    Floating-point number with 6 decimal places optimized for storage.
    
    See Also:
    
    Constant Field Values
  - FLOAT_SET_LOW_0
```
public static final int FLOAT_SET_LOW_0
```
    Floating-point number rounded to the nearest whole number.
    
    See Also:
    
    Constant Field Values
  - FLOAT_SET_LOW_2
```
public static final int FLOAT_SET_LOW_2
```
    Floating-point number rounded to 2 decimal places for compact storage.
    
    See Also:
    
    Constant Field Values
  - FLOAT_SET_LOW_4
```
public static final int FLOAT_SET_LOW_4
```
    Floating-point number rounded to 4 decimal places for compact storage.
    
    See Also:
    
    Constant Field Values
  - UUID
```
public static final int UUID
```
    Represents a universally unique identifier (UUID).
    
    See Also:
    
    Constant Field Values
  - UINT8
```
public static final int UINT8
```
    Unsigned 8-bit integer (byte).
    
    See Also:
    
    Constant Field Values
  - UINT16
```
public static final int UINT16
```
    Unsigned 16-bit integer (short).
    
    See Also:
    
    Constant Field Values
  - UINT32
```
public static final int UINT32
```
    Unsigned 32-bit integer.
    
    See Also:
    
    Constant Field Values
  - INT8
```
public static final int INT8
```
    Signed 8-bit integer (byte).
    
    See Also:
    
    Constant Field Values
  - INT16
```
public static final int INT16
```
    Signed 16-bit integer (short).
    
    See Also:
    
    Constant Field Values
  - INT32
```
public static final int INT32
```
    Signed 32-bit integer.
    
    See Also:
    
    Constant Field Values
  - INT64
```
public static final int INT64
```
    Signed 64-bit integer (long).
    
    See Also:
    
    Constant Field Values
  - SET_LOW_INT8
```
public static final int SET_LOW_INT8
```
    8-bit integer with optimized storage for low positive values.
    
    See Also:
    
    Constant Field Values
  - SET_LOW_INT16
```
public static final int SET_LOW_INT16
```
    16-bit integer with optimized storage for low positive values.
    
    See Also:
    
    Constant Field Values
  - INT64_0x
```
public static final int INT64_0x
```
    64-bit integer to be displaying in hexadecimal format.
    
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final int FALSE
```
    boolean value representing 'false'.
    
    See Also:
    
    Constant Field Values
  - TRUE
```
public static final int TRUE
```
    boolean value representing 'true'.
    
    See Also:
    
    Constant Field Values
  - TIME
```
public static final int TIME
```
    Represents a time value.
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final int DATE
```
    Represents a date value.
    
    See Also:
    
    Constant Field Values
  - DATE_TIME
```
public static final int DATE_TIME
```
    Represents a date-time value.
    
    See Also:
    
    Constant Field Values
  - ZONED_DATE_TIME
```
public static final int ZONED_DATE_TIME
```
    Represents a zoned date-time value.
    
    See Also:
    
    Constant Field Values
  - TYPE_PREFIX
```
public static final int TYPE_PREFIX
```
    Prefix indicating the type of the following serialized object.
    
    See Also:
    
    Constant Field Values
  - FIELD_NAME_ANY
```
public static final int FIELD_NAME_ANY
```
    A field name of any length.
    
    See Also:
    
    Constant Field Values
  - STRING_ANY
```
public static final int STRING_ANY
```
    A String of any length
    
    See Also:
    
    Constant Field Values
  - EVENT_NAME
```
public static final int EVENT_NAME
```
    A field of any length, marked as an event name.
    
    See Also:
    
    Constant Field Values
  - FIELD_NUMBER
```
public static final int FIELD_NUMBER
```
    Represents a numerical field number instead of a name.
    
    See Also:
    
    Constant Field Values
  - NULL
```
public static final int NULL
```
    Code representing a null value in the serialized data.
    
    See Also:
    
    Constant Field Values
  - TYPE_LITERAL
```
public static final int TYPE_LITERAL
```
    Represents a type literal.
    
    See Also:
    
    Constant Field Values
  - EVENT_OBJECT
```
public static final int EVENT_OBJECT
```
    Indicates an event object instead of the typical string.
    
    See Also:
    
    Constant Field Values
  - COMMENT
```
public static final int COMMENT
```
    Marks a comment, not intended for parsing as part of the data structure.
    
    See Also:
    
    Constant Field Values
  - HINT
```
public static final int HINT
```
    Provides a hint for serialization or deserialization processes, possibly affecting how data is interpreted.
    
    See Also:
    
    Constant Field Values
  - FIELD_NAME0
```
public static final int FIELD_NAME0
```
    Starting code for predefined field names of length 0, 1, 2 ... 31.
    
    See Also:
    
    Constant Field Values
  - FIELD_NAME31
```
public static final int FIELD_NAME31
```
    Ending code for predefined field names.
    
    See Also:
    
    Constant Field Values
  - STRING_0
```
public static final int STRING_0
```
    Starting code for compact string representation of length 0, 1, 2 ... 31.
    
    See Also:
    
    Constant Field Values
  - STRING_31
```
public static final int STRING_31
```
    Ending code for compact string representation.
    
    See Also:
    
    Constant Field Values
  - STRING_FOR_CODE
```
public static final String[] STRING_FOR_CODE
```
    Array storing the string representations for each binary wire code, facilitating easier debugging and logging.
- Method Detail
  - values
```
public static BinaryWireCode[] 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 (BinaryWireCode c : BinaryWireCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BinaryWireCode 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
  - isFieldCode
```
public static boolean isFieldCode(int code)
```
    Determines if the provided code corresponds to a field name.
    
    Parameters:
    
    code - The binary wire code value.
    
    Returns:
    
    True if the code corresponds to a field, false otherwise.
  - stringForCode
```
@NotNull
public static @NotNull String stringForCode(int code)
```
    Retrieves the string representation of a binary wire code.
    
    Parameters:
    
    code - The binary wire code value.
    
    Returns:
    
    The string representation for the given code.

Enum BinaryWireCode

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Field Detail

BYTES_LENGTH8

BYTES_LENGTH16

BYTES_LENGTH32

BYTES_MARSHALLABLE

HISTORY_MESSAGE

FIELD_ANCHOR

ANCHOR

UPDATED_ALIAS

U8_ARRAY

I64_ARRAY

PADDING32

PADDING

FLOAT32

FLOAT64

FLOAT_STOP_2

FLOAT_STOP_4

FLOAT_STOP_6

FLOAT_SET_LOW_0

FLOAT_SET_LOW_2

FLOAT_SET_LOW_4

UUID

UINT8

UINT16

UINT32

INT8

INT16

INT32

INT64

SET_LOW_INT8

SET_LOW_INT16

INT64_0x

FALSE

TRUE

TIME

DATE

DATE_TIME

ZONED_DATE_TIME

TYPE_PREFIX

FIELD_NAME_ANY

STRING_ANY

EVENT_NAME

FIELD_NUMBER

NULL

TYPE_LITERAL

EVENT_OBJECT

COMMENT

HINT

FIELD_NAME0

FIELD_NAME31

STRING_0

STRING_31

STRING_FOR_CODE

Method Detail

values

valueOf

isFieldCode

stringForCode