net.openhft.chronicle.wire

Class AbstractMarshallableCfg

java.lang.Object

net.openhft.chronicle.wire.AbstractCommonMarshallable

net.openhft.chronicle.wire.SelfDescribingMarshallable

net.openhft.chronicle.wire.AbstractMarshallableCfg

All Implemented Interfaces:

net.openhft.chronicle.bytes.BytesMarshallable, net.openhft.chronicle.bytes.CommonMarshallable, net.openhft.chronicle.bytes.ReadBytesMarshallable, net.openhft.chronicle.bytes.WriteBytesMarshallable, net.openhft.chronicle.core.io.Resettable, Marshallable, ReadMarshallable, WriteMarshallable, WriteValue

Direct Known Subclasses:

AbstractEventCfg

public abstract class AbstractMarshallableCfg
extends SelfDescribingMarshallable

An abstract class that represents a configuration Data Transfer Object (DTO) capable of marshalling. This base class offers default implementations for reading and writing configurations through WireMarshaller. Derived configuration DTOs can benefit from merging default configurations with specific configurations to enhance flexibility.

Field Summary

Fields inherited from interface net.openhft.chronicle.wire.WriteMarshallable

EMPTY

Fields inherited from interface net.openhft.chronicle.wire.ReadMarshallable

DISCARD

Constructor Summary

Constructors

Constructor and Description
AbstractMarshallableCfg()

Method Summary

Modifier and Type	Method and Description
void	readMarshallable(@NotNull WireIn wire) Reads the state of this configuration object from the given wire input.
void	unexpectedField(Object event, ValueIn valueIn) Handles the presence of unexpected fields during the reading process.
void	writeMarshallable(@NotNull WireOut wire) Writes the state of this configuration object to the given wire output.

Methods inherited from class net.openhft.chronicle.wire.SelfDescribingMarshallable

usesSelfDescribingMessage

Methods inherited from class net.openhft.chronicle.wire.AbstractCommonMarshallable

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.openhft.chronicle.wire.Marshallable

$equals, $fieldInfoMap, $fieldInfos, $hashCode, $toString, className, copyTo, deepCopy, fromFile, fromFile, fromString, fromString, fromString, getField, getLongField, mergeToMap, reset, setField, setLongField, streamFromFile, streamFromFile

Methods inherited from interface net.openhft.chronicle.wire.WriteMarshallable

binaryLengthLength, writeValue

Methods inherited from interface net.openhft.chronicle.bytes.BytesMarshallable

$toString, readMarshallable, writeMarshallable

Constructor Detail

AbstractMarshallableCfg

public AbstractMarshallableCfg()

Method Detail

readMarshallable

public void readMarshallable(@NotNull
                             @NotNull WireIn wire)
                      throws net.openhft.chronicle.core.io.IORuntimeException,
                             net.openhft.chronicle.core.io.InvalidMarshallableException

Reads the state of this configuration object from the given wire input. It uses the WireMarshaller corresponding to the class of the current object to perform the reading.

Configuration merging is supported; absent values in the wire input retain their existing state. To ensure the use of default values for any unset attributes, consider invoking reset() before this method.

Parameters:

wire - Wire input source for reading the configuration.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If there's an IO-related exception during reading.

net.openhft.chronicle.core.io.InvalidMarshallableException - If a marshalling error occurs.

writeMarshallable

public void writeMarshallable(@NotNull
                              @NotNull WireOut wire)
                       throws net.openhft.chronicle.core.io.InvalidMarshallableException

Writes the state of this configuration object to the given wire output. It uses the WireMarshaller corresponding to the class of the current object to perform the writing.

For brevity, only fields differing from default values are written.

Parameters:

wire - Wire output target for writing the configuration.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If a marshalling error occurs.

unexpectedField

public void unexpectedField(Object event,
                            ValueIn valueIn)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException

Handles the presence of unexpected fields during the reading process. A warning is logged with details of the unexpected field.

Parameters:

event - The name or identifier of the unexpected field.

valueIn - The value associated with the unexpected field.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an error during the processing.