net.openhft.chronicle.wire

Enum WireInternal

java.lang.Object

java.lang.Enum<WireInternal>

net.openhft.chronicle.wire.WireInternal

All Implemented Interfaces:

Serializable, Comparable<WireInternal>

public enum WireInternal
extends Enum<WireInternal>

The WireInternal enum provides a collection of utility constants, data structures, and internal configurations to support wire operations. This enum does not have any direct instances (as signified by the empty enum declaration). Instead, it serves as a container for static members.

Method Summary

Modifier and Type	Method and Description
static <E extends Enum<E>> E	internEnum(@NotNull Class<E> eClass, @NotNull CharSequence cs) Returns the interned instance of the given enum E that matches the specified character sequence.
static void	rawReadData(@NotNull WireIn wireIn, @NotNull ReadMarshallable dataConsumer) Reads raw data from the given wireIn without processing metadata and uses the provided dataConsumer to process this data.
static boolean	readData(long offset, @NotNull WireIn wireIn, @Nullable ReadMarshallable metaDataConsumer, @Nullable ReadMarshallable dataConsumer) Reads data from the provided wireIn starting from the given offset, and processes the data using the provided meta data and data consumers.
static boolean	readData(@NotNull WireIn wireIn, @Nullable ReadMarshallable metaDataConsumer, @Nullable ReadMarshallable dataConsumer) Reads data from the given wireIn and processes the data using the provided meta data and data consumers.
static Throwable	throwable(@NotNull ValueIn valueIn, boolean appendCurrentStack) Creates a throwable instance based on the type provided by valueIn.
protected static Throwable	throwable(@NotNull ValueIn valueIn, boolean appendCurrentStack, Throwable throwable) Creates and processes a throwable object based on the data present in the provided valueIn.
static WireInternal	valueOf(String name) Returns the enum constant of this type with the specified name.
static WireInternal[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static long	writeData(@NotNull WireOut wireOut, boolean metaData, boolean notComplete, @NotNull WriteMarshallable writer) Writes data to the provided wireOut based on the given configurations and writer.

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

Method Detail

values

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

Returns:

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

valueOf

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

internEnum

@NotNull
public static <E extends Enum<E>> E internEnum(@NotNull
                                                        @NotNull Class<E> eClass,
                                                        @NotNull
                                                        @NotNull CharSequence cs)

Returns the interned instance of the given enum E that matches the specified character sequence. The method ensures that repeated requests for the same enum instance return the same shared object.

Type Parameters:

E - The enum type

Parameters:

eClass - The class of the enum type

cs - The character sequence that represents the enum constant

Returns:

The interned enum constant that matches the provided character sequence

writeData

public static long writeData(@NotNull
                             @NotNull WireOut wireOut,
                             boolean metaData,
                             boolean notComplete,
                             @NotNull
                             @NotNull WriteMarshallable writer)
                      throws net.openhft.chronicle.core.io.InvalidMarshallableException

Writes data to the provided wireOut based on the given configurations and writer.

Parameters:

wireOut - The output wire to write to

metaData - A flag indicating if meta data should be included in the write

notComplete - A flag indicating if the data is not complete

writer - The writer responsible for writing the marshallable data

Returns:

The position where the data was written

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If the provided data cannot be marshalled properly

readData

public static boolean readData(long offset,
                               @NotNull
                               @NotNull WireIn wireIn,
                               @Nullable
                               @Nullable ReadMarshallable metaDataConsumer,
                               @Nullable
                               @Nullable ReadMarshallable dataConsumer)
                        throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads data from the provided wireIn starting from the given offset, and processes the data using the provided meta data and data consumers.

Parameters:

offset - The offset to start reading from within the wire input

wireIn - The input wire to read data from

metaDataConsumer - The consumer responsible for processing meta data. May be null if meta data processing is not required.

dataConsumer - The consumer responsible for processing the actual data. May be null if data processing is not required.

Returns:

A boolean value indicating success or failure of reading the data.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If the data cannot be unmarshalled properly.

readData

public static boolean readData(@NotNull
                               @NotNull WireIn wireIn,
                               @Nullable
                               @Nullable ReadMarshallable metaDataConsumer,
                               @Nullable
                               @Nullable ReadMarshallable dataConsumer)
                        throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads data from the given wireIn and processes the data using the provided meta data and data consumers. This method continues to read as long as there is data to read and processes the data based on its header to determine whether it's meta data or actual data.

Parameters:

wireIn - The input wire to read data from.

metaDataConsumer - The consumer responsible for processing meta data. May be null if meta data processing is not required.

dataConsumer - The consumer responsible for processing the actual data. May be null if data processing is not required.

Returns:

A boolean value indicating whether any data was successfully read. True if data was read, false otherwise.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If the data cannot be unmarshalled properly or there's an issue with the data structure.

BufferUnderflowException - If attempting to read more data than what's available.

rawReadData

public static void rawReadData(@NotNull
                               @NotNull WireIn wireIn,
                               @NotNull
                               @NotNull ReadMarshallable dataConsumer)
                        throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads raw data from the given wireIn without processing metadata and uses the provided dataConsumer to process this data.

Parameters:

wireIn - The input wire from which data is read.

dataConsumer - The consumer responsible for processing the actual data.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If the data cannot be unmarshalled properly or there's an issue with the data structure.

throwable

public static Throwable throwable(@NotNull
                                  @NotNull ValueIn valueIn,
                                  boolean appendCurrentStack)
                           throws net.openhft.chronicle.core.io.InvalidMarshallableException

Creates a throwable instance based on the type provided by valueIn. Optionally, this method can also append the current stack trace to the throwable if appendCurrentStack is true.

Parameters:

valueIn - The value input from which the type of the throwable is determined.

appendCurrentStack - Flag indicating whether to append the current stack trace to the throwable.

Returns:

A throwable instance of the type determined from valueIn.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If the throwable cannot be instantiated properly.

throwable

protected static Throwable throwable(@NotNull
                                     @NotNull ValueIn valueIn,
                                     boolean appendCurrentStack,
                                     Throwable throwable)
                              throws net.openhft.chronicle.core.io.InvalidMarshallableException

Creates and processes a throwable object based on the data present in the provided valueIn. The provided throwable is populated with a message and stack trace extracted from the valueIn. Optionally, the current stack trace can be appended to the throwable's stack trace.

Parameters:

valueIn - The value input containing the details of the throwable.

appendCurrentStack - Flag indicating whether to append the current stack trace to the throwable.

throwable - The throwable to be populated with details from valueIn.

Returns:

The processed throwable.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If the data in valueIn cannot be processed properly.