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 serialized and deserialized.

This enumeration provides utilities to check for the availability of certain wire types such as DeltaWire and DefaultZeroWire. It also provides methods to acquire bytes, useful in serialization operations.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BINARY Use this ONLY if intend to use Delta and Binary.
BINARY_LIGHT Use this when only need to use Binary (does not support DeltaWire)
COMPRESSED_BINARY
CSV
DEFAULT_ZERO_BINARY Deprecated.
DELTA_BINARY Deprecated.
FIELDLESS_BINARY
JSON
JSON_ONLY
RAW
READ_ANY
TEXT
YAML
YAML_ONLY

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) Converts the provided CharSequence into a Map<String, Object> representation using Wire.
String	asString(Object marshallable) Converts a given marshallable object to its string representation.
<T> T	fromFile(@NotNull Class<T> expectedType, String filename) Deserializes an object of a specified type from a file.
<T> T	fromFile(String filename) Deserializes an object of generic type from a file.
<T> T	fromString(@NotNull CharSequence cs) deserializes with an optimistic cast
<T> T	fromString(Class<T> tClass, @NotNull CharSequence cs) deserializes as a given class
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) Streams objects of a specified type from a Bytes instance.
<T> @NotNull Stream<T>	streamFromFile(@NotNull Class<T> expectedType, String filename) Streams objects of a specified type from a file.
<T> @NotNull Stream<T>	streamFromFile(String filename) Streams objects of generic type from a file.
void	toFile(@NotNull String filename, WriteMarshallable marshallable) Writes a WriteMarshallable object to a file.
<T extends Marshallable> void	toFileAsMap(@NotNull String filename, @NotNull Map<String,T> map) Deprecated.
<T extends Marshallable> void	toFileAsMap(@NotNull String filename, @NotNull Map<String,T> map, boolean compact) Deprecated.
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 of a given Wire instance.
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

BINARY

public static final WireType BINARY

Use this ONLY if intend to use Delta and Binary. Otherwise, use BINARY_LIGHT

BINARY_LIGHT

public static final WireType BINARY_LIGHT

Use this when only need to use Binary (does not support DeltaWire)

DEFAULT_ZERO_BINARY

@Deprecated
public static final WireType DEFAULT_ZERO_BINARY

Deprecated.

DELTA_BINARY

@Deprecated
public static final WireType DELTA_BINARY

Deprecated.

FIELDLESS_BINARY

public static final WireType FIELDLESS_BINARY

COMPRESSED_BINARY

public static final WireType COMPRESSED_BINARY

JSON

public static final WireType JSON

JSON_ONLY

public static final WireType JSON_ONLY

YAML

public static final WireType YAML

YAML_ONLY

public static final WireType YAML_ONLY

RAW

public static final WireType RAW

CSV

public static final WireType CSV

READ_ANY

public static final WireType READ_ANY

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

valueOf

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

Determines the of a given Wire instance. This method inspects the underlying type of the provided wire instance and maps it to its corresponding WireType.

Parameters:

wire - The wire instance whose type needs to be determined.

Returns:

The corresponding WireType of the given wire, or null if the input wire is null.

Throws:

IllegalStateException - If the wire type is unrecognized.

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

deserializes with an optimistic cast

Type Parameters:

T - the type to expect

Parameters:

cs - text to deserialize

Returns:

the object deserialized

Throws:

ClassCastException - if the object is not a 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

deserializes as a given class

Parameters:

tClass - to serialize as

cs - text to deserialize

Returns:

the object deserialized

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

fromFile

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

Deserializes an object of generic type from a file.

Type Parameters:

T - The type of the object to be deserialized.

Parameters:

filename - The path to the file containing the serialized object.

Returns:

The deserialized object.

Throws:

IOException - If there's an error reading the file.

net.openhft.chronicle.core.io.InvalidMarshallableException - If the object cannot be properly deserialized.

fromFile

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

Deserializes an object of a specified type from a file.

Type Parameters:

T - The type of the object to be deserialized.

Parameters:

expectedType - The expected type of the object to be deserialized.

filename - The path to the file containing the serialized object.

Returns:

The deserialized object, or null if the object could not be deserialized.

Throws:

IOException - If there's an error reading the file.

net.openhft.chronicle.core.io.InvalidMarshallableException - If the object cannot be properly deserialized.

streamFromFile

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

Streams objects of generic type from a file.

Type Parameters:

T - The type of the objects to be streamed.

Parameters:

filename - The path to the file containing the serialized objects.

Returns:

A stream of the deserialized objects.

Throws:

IOException - If there's an error reading the file.

streamFromFile

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

Streams objects of a specified type from a file.

Type Parameters:

T - The type of the objects to be streamed.

Parameters:

expectedType - The expected type of the objects to be streamed.

filename - The path to the file containing the serialized objects.

Returns:

A stream of the deserialized objects.

Throws:

IOException - If there's an error reading the file.

streamFromBytes

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

Streams objects of a specified type from a Bytes instance.

Type Parameters:

T - The type of the objects to be streamed.

Parameters:

expectedType - The expected type of the objects to be streamed.

b - The Bytes instance containing the serialized objects.

Returns:

A stream of the deserialized objects.

toFileAsMap

@Deprecated
public <T extends Marshallable> void toFileAsMap(@NotNull
                                                             @NotNull String filename,
                                                             @NotNull
                                                             @NotNull Map<String,T> map)
                                                      throws IOException,
                                                             net.openhft.chronicle.core.io.InvalidMarshallableException

Deprecated.

Throws:

IOException

net.openhft.chronicle.core.io.InvalidMarshallableException

toFileAsMap

@Deprecated
public <T extends Marshallable> void toFileAsMap(@NotNull
                                                             @NotNull String filename,
                                                             @NotNull
                                                             @NotNull Map<String,T> map,
                                                             boolean compact)
                                                      throws IOException,
                                                             net.openhft.chronicle.core.io.InvalidMarshallableException

Deprecated.

Throws:

IOException

net.openhft.chronicle.core.io.InvalidMarshallableException

toFile

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

Writes a WriteMarshallable object to a file.

Parameters:

filename - The name of the file to write to.

marshallable - The object to write.

Throws:

IOException - If there's an error writing to the file.

net.openhft.chronicle.core.io.InvalidMarshallableException - If the object cannot be properly serialized.

asMap

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

Converts the provided CharSequence into a Map<String, Object> representation using Wire.

Parameters:

cs - The CharSequence to be converted.

Returns:

A Map with String keys and Object values.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If the CharSequence cannot be properly deserialized.

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.