net.openhft.chronicle.wire

Enum WireType

java.lang.Object

java.lang.Enum<WireType>

net.openhft.chronicle.wire.WireType

All Implemented Interfaces:

Serializable, Comparable<WireType>, Function<net.openhft.chronicle.bytes.Bytes<?>,Wire>, net.openhft.chronicle.core.LicenceCheck

public enum WireType
extends Enum<WireType>
implements Function<net.openhft.chronicle.bytes.Bytes<?>,Wire>, net.openhft.chronicle.core.LicenceCheck

Enumerates a selection of prebuilt wire types. These wire types define specific ways data can be serialised and deserialised. Each enum constant acts as a factory (Function<Bytes<?>, Wire>) creating a concrete Wire instance initialised with a provided Bytes buffer.

Helper methods are supplied to obtain temporary Bytes for serialisation operations.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BINARY High performance binary wire format.
BINARY_LIGHT High performance binary wire format optimised for speed and size.
COMPRESSED_BINARY Deprecated.
CSV Comma Separated Values text wire format.
FIELDLESS_BINARY Compact binary wire format that omits field names.
JSON JSON-compliant text wire format.
JSON_ONLY JSON-compliant text wire format that uses explicit type prefixes and text document delimiters.
JSONL JSON Lines (JSONL) text wire format.
RAW Raw binary wire format with minimal metadata.
READ_ANY Special wire type that detects either TEXT or BINARY (including FIELDLESS_BINARY) by inspecting the input stream.
TEXT A human-readable, YAML-like text wire format.
YAML YAML-compliant text wire format.
YAML_ONLY YAML-compliant text wire format using text document delimiters such as --- and ....

Field Summary

Fields inherited from interface net.openhft.chronicle.core.LicenceCheck

CHRONICLE_LICENSE

Method Summary

Modifier and Type	Method and Description
@Nullable Map<String,Object>	asMap(@NotNull CharSequence cs) Deserialises the supplied text into a Map<String, Object>.
String	asString(Object marshallable) Converts a given marshallable object to its string representation.
protected @NotNull String	asUtf8String(Object marshallable) Serialises marshallable using this wire type into an in-memory buffer and returns the result as a UTF-8 string.
<T> T	fromFile(@NotNull Class<T> expectedType, String filename) Deserialises an object of the given type from a file produced in this wire format.
<T> T	fromFile(String filename) Deserialises a Marshallable from the given file.
<T> T	fromString(@NotNull CharSequence cs) Deserialises an object of an inferred type from the provided text.
<T> T	fromString(Class<T> tClass, @NotNull CharSequence cs) Deserialises an object of the given type from the provided text.
boolean	isAvailable()
boolean	isText() Indicates if this WireType is of a textual nature.
void	licenceCheck()
Supplier<net.openhft.chronicle.core.values.BooleanValue>	newBooleanReference() Provides a supplier for a new BooleanValue reference using BinaryBooleanReference.
Supplier<net.openhft.chronicle.core.values.IntValue>	newIntReference() Provides a supplier for a new IntValue reference using BinaryIntReference.
Supplier<net.openhft.chronicle.core.values.LongArrayValues>	newLongArrayReference() Provides a supplier for a new LongArrayValues reference using BinaryLongArrayReference.
Supplier<net.openhft.chronicle.core.values.LongValue>	newLongReference() Provides a supplier for a new LongValue reference using BinaryLongReference.
Supplier<net.openhft.chronicle.core.values.TwoLongValue>	newTwoLongReference() Provides a supplier for a new TwoLongValue reference using BinaryTwoLongReference.
<T> @NotNull Stream<T>	streamFromBytes(@NotNull Class<T> expectedType, net.openhft.chronicle.bytes.Bytes<?> b) Creates a Stream of objects by deserialising documents from the provided Bytes buffer.
<T> @NotNull Stream<T>	streamFromFile(@NotNull Class<T> expectedType, String filename) Deserialises objects of the given type from a file.
<T> @NotNull Stream<T>	streamFromFile(String filename) Deserialises a sequence of objects from the specified file.
void	toFile(@NotNull String filename, WriteMarshallable marshallable) Serialises marshallable to filename using this wire type.
static WireType	valueOf(String name) Returns the enum constant of this type with the specified name.
static @Nullable WireType	valueOf(@Nullable Wire wire) Determines the WireType of a given Wire.
static WireType[]	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

Methods inherited from interface java.util.function.Function

andThen, apply, compose, identity

Methods inherited from interface net.openhft.chronicle.core.LicenceCheck

check, isJGuardProtected, licenceExpiry

Enum Constant Detail

TEXT

public static final WireType TEXT

A human-readable, YAML-like text wire format. If the system property wire.testAsYaml is true it behaves like YAML. Uses binary documents and padding by default.

BINARY

public static final WireType BINARY

High performance binary wire format. This is an alias for BINARY_LIGHT.

BINARY_LIGHT

public static final WireType BINARY_LIGHT

High performance binary wire format optimised for speed and size. Does not support legacy DeltaWire features.

FIELDLESS_BINARY

public static final WireType FIELDLESS_BINARY

Compact binary wire format that omits field names. Deserialisation relies on DTO field order.

COMPRESSED_BINARY

@Deprecated
public static final WireType COMPRESSED_BINARY

Deprecated.

Deprecated: To be removed in x.29. Use BINARY_LIGHT. Binary wire format that formerly supported LZW style compression for messages exceeding COMPRESSED_SIZE.

JSON

public static final WireType JSON

JSON-compliant text wire format. Uses binary documents and padding by default and does not include type prefixes unless configured.

JSON_ONLY

public static final WireType JSON_ONLY

JSON-compliant text wire format that uses explicit type prefixes and text document delimiters. The first curly brace is not trimmed by default.

JSONL

public static final WireType JSONL

JSON Lines (JSONL) text wire format. Each document is a complete JSON object on a single line terminated by newline. Type prefixes are not included in the output.

See Also:

JSON Lines specification

YAML

public static final WireType YAML

YAML-compliant text wire format. Uses binary documents and padding by default.

YAML_ONLY

public static final WireType YAML_ONLY

YAML-compliant text wire format using text document delimiters such as --- and ....

RAW

public static final WireType RAW

Raw binary wire format with minimal metadata. Ideal for fixed-layout data and offers the highest performance.

CSV

public static final WireType CSV

Comma Separated Values text wire format.

READ_ANY

public static final WireType READ_ANY

Special wire type that detects either TEXT or BINARY (including FIELDLESS_BINARY) by inspecting the input stream.

Method Detail

values

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

Returns:

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

valueOf

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

asUtf8String

@NotNull
protected @NotNull String asUtf8String(Object marshallable)

Serialises marshallable using this wire type into an in-memory buffer and returns the result as a UTF-8 string.

valueOf

@Nullable
public static @Nullable WireType valueOf(@Nullable
                                                   @Nullable Wire wire)

Determines the WireType of a given Wire. The concrete wire is inspected and mapped to the matching enum constant.

Parameters:

wire - the wire instance to examine

Returns:

the matching WireType or null if wire is null

Throws:

IllegalStateException - if the type is unknown

newIntReference

public Supplier<net.openhft.chronicle.core.values.IntValue> newIntReference()

Provides a supplier for a new IntValue reference using BinaryIntReference.

Returns:

A supplier that creates a new BinaryIntReference.

newBooleanReference

public Supplier<net.openhft.chronicle.core.values.BooleanValue> newBooleanReference()

Provides a supplier for a new BooleanValue reference using BinaryBooleanReference.

Returns:

A supplier that creates a new BinaryBooleanReference.

newLongReference

public Supplier<net.openhft.chronicle.core.values.LongValue> newLongReference()

Provides a supplier for a new LongValue reference using BinaryLongReference.

Returns:

A supplier that creates a new BinaryLongReference.

newTwoLongReference

public Supplier<net.openhft.chronicle.core.values.TwoLongValue> newTwoLongReference()

Provides a supplier for a new TwoLongValue reference using BinaryTwoLongReference.

Returns:

A supplier that creates a new BinaryTwoLongReference.

newLongArrayReference

public Supplier<net.openhft.chronicle.core.values.LongArrayValues> newLongArrayReference()

Provides a supplier for a new LongArrayValues reference using BinaryLongArrayReference.

Returns:

A supplier that creates a new BinaryLongArrayReference.

asString

public String asString(Object marshallable)

Converts a given marshallable object to its string representation. This method ensures the object is first converted to a byte buffer, and then the buffer's contents are returned as a string.

Parameters:

marshallable - The object to be converted to string.

Returns:

The string representation of the object.

fromString

@Nullable
public <T> T fromString(@NotNull
                                  @NotNull CharSequence cs)
                           throws net.openhft.chronicle.core.io.InvalidMarshallableException

Deserialises an object of an inferred type from the provided text.

Type Parameters:

T - expected type

Parameters:

cs - text to read

Returns:

the object deserialised

Throws:

ClassCastException - if the object is not of type T

net.openhft.chronicle.core.io.InvalidMarshallableException

fromString

public <T> T fromString(Class<T> tClass,
                        @NotNull
                        @NotNull CharSequence cs)
                 throws net.openhft.chronicle.core.io.InvalidMarshallableException

Deserialises an object of the given type from the provided text.

Parameters:

tClass - the expected type

cs - text to parse

Returns:

the object deserialised

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

fromFile

@NotNull
public <T> T fromFile(String filename)
                        throws IOException,
                               net.openhft.chronicle.core.io.InvalidMarshallableException

Deserialises a Marshallable from the given file.

Type Parameters:

T - the desired type

Parameters:

filename - path to the input file

Returns:

the object read from the file

Throws:

IOException - if the file cannot be read

net.openhft.chronicle.core.io.InvalidMarshallableException - if decoding fails

fromFile

@Nullable
public <T> T fromFile(@NotNull
                                @NotNull Class<T> expectedType,
                                String filename)
                         throws IOException,
                                net.openhft.chronicle.core.io.InvalidMarshallableException

Deserialises an object of the given type from a file produced in this wire format.

Type Parameters:

T - object type

Parameters:

expectedType - type to read

filename - input file path

Returns:

the object read from the file

Throws:

IOException - if the file cannot be read

net.openhft.chronicle.core.io.InvalidMarshallableException - if decoding fails

streamFromFile

@NotNull
public <T> @NotNull Stream<T> streamFromFile(String filename)
                                               throws IOException

Deserialises a sequence of objects from the specified file.

Type Parameters:

T - object type

Parameters:

filename - file to read

Returns:

a stream of objects

Throws:

IOException - if the file cannot be read

streamFromFile

@NotNull
public <T> @NotNull Stream<T> streamFromFile(@NotNull
                                                      @NotNull Class<T> expectedType,
                                                      String filename)
                                               throws IOException

Deserialises objects of the given type from a file.

Type Parameters:

T - object type

Parameters:

expectedType - expected object type

filename - file to read

Returns:

a stream of objects

Throws:

IOException - if the file cannot be read

streamFromBytes

@NotNull
public <T> @NotNull Stream<T> streamFromBytes(@NotNull
                                                       @NotNull Class<T> expectedType,
                                                       net.openhft.chronicle.bytes.Bytes<?> b)

Creates a Stream of objects by deserialising documents from the provided Bytes buffer.

Type Parameters:

T - object type

Parameters:

expectedType - expected object type

b - source bytes

Returns:

a stream of objects

toFile

public void toFile(@NotNull
                   @NotNull String filename,
                   WriteMarshallable marshallable)
            throws IOException,
                   net.openhft.chronicle.core.io.InvalidMarshallableException

Serialises marshallable to filename using this wire type. The data is first written to a temporary file which is then renamed for atomicity.

Parameters:

filename - target file

marshallable - object to write

Throws:

IOException - if the file cannot be written

net.openhft.chronicle.core.io.InvalidMarshallableException - if encoding fails

asMap

@Nullable
public @Nullable Map<String,Object> asMap(@NotNull
                                                    @NotNull CharSequence cs)
                                             throws net.openhft.chronicle.core.io.InvalidMarshallableException

Deserialises the supplied text into a Map<String, Object>.

Parameters:

cs - text formatted according to this wire type

Returns:

a map representation

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if parsing fails

licenceCheck

public void licenceCheck()

Specified by:

licenceCheck in interface net.openhft.chronicle.core.LicenceCheck

isAvailable

public boolean isAvailable()

Specified by:

isAvailable in interface net.openhft.chronicle.core.LicenceCheck

isText

public boolean isText()

Indicates if this WireType is of a textual nature. This implementation returns false, indicating it's not textual.

Returns:

true if the WireType is textual; false otherwise.