net.openhft.chronicle.wire

Enum BracketType

java.lang.Object

java.lang.Enum<BracketType>

net.openhft.chronicle.wire.BracketType

All Implemented Interfaces:

Serializable, Comparable<BracketType>

public enum BracketType
extends Enum<BracketType>

Represents the type of bracketing used in serialized data formats, particularly in the context of Chronicle Wire serialization/deserialization processes. This enumeration helps in identifying the structural format (e.g., maps, sequences) of the data or the absence thereof, facilitating appropriate parsing and writing operations based on the data type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HISTORY_MESSAGE Represents a special case used internally for processing history messages.
MAP Denotes the use of curly brackets '{}' associated with maps.
NONE Signifies that no bracketing is used.
SEQ Denotes the use of square brackets '[]' typically associated with sequences or lists.
UNKNOWN Indicates an unknown bracketing type.

Method Summary

Modifier and Type	Method and Description
static BracketType	valueOf(String name) Returns the enum constant of this type with the specified name.
static BracketType[]	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

UNKNOWN

public static final BracketType UNKNOWN

Indicates an unknown bracketing type. This is typically used in scenarios where the bracketing type cannot be determined due to the data not adhering to expected formats, or when the parsing process has not yet identified the data structure. It serves as a placeholder for error handling and initial states before the actual bracketing type is recognized.

NONE

public static final BracketType NONE

Signifies that no bracketing is used. This bracket type is applicable in situations where the data does not conform to structured types like maps or sequences. For instance, it might be used for simple values or in cases where the data structure is flat and does not require nested bracketing. It's also the default type for certain data entries that do not fit traditional bracketed structures.

MAP

public static final BracketType MAP

Denotes the use of curly brackets '{}' associated with maps. This bracket type is utilized when parsing or writing key-value pairs, indicating that the data should be interpreted as a map structure. It is critical for handling complex, structured data that benefits from key-based access, enabling efficient serialization and deserialization of map-like data constructs.

SEQ

public static final BracketType SEQ

Denotes the use of square brackets '[]' typically associated with sequences or lists. This bracket type indicates that the data should be treated as an ordered collection, suitable for iterating or accessing elements by index. It is essential for representing lists of items, facilitating the serialization and deserialization of sequences in a manner that preserves the order and structure of the collection.

HISTORY_MESSAGE

public static final BracketType HISTORY_MESSAGE

Represents a special case used internally for processing history messages. This type is leveraged in specific contexts where the data pertains to historical records or messages that require unique handling. It indicates a custom structure or processing rule that differs from conventional maps or sequences, tailored to the requirements of history message serialization and deserialization.

Method Detail

values

public static BracketType[] 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 (BracketType c : BracketType.values())
    System.out.println(c);

Returns:

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

valueOf

public static BracketType 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