net.openhft.chronicle.wire

Class WireMarshaller<T>

java.lang.Object

net.openhft.chronicle.wire.WireMarshaller<T>

Direct Known Subclasses:

WireMarshallerForUnexpectedFields

public class WireMarshaller<T>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static net.openhft.chronicle.core.ClassLocal<WireMarshaller>	WIRE_MARSHALLER_CL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WireMarshaller(@NotNull Class<T> tClass, @NotNull net.openhft.chronicle.wire.WireMarshaller.FieldAccess[] fields, boolean isLeaf)

Method Summary

Modifier and Type	Method and Description
T	defaultValue()
WireMarshaller<T>	excludeFields(String... fieldNames)
static void	getAllField(@NotNull Class clazz, @NotNull Map<String,Field> map)
Object	getField(Object o, String name)
long	getLongField(@NotNull Object o, String name)
boolean	isEqual(Object o1, Object o2)
boolean	isLeaf()
protected static boolean	leafable(net.openhft.chronicle.wire.WireMarshaller.FieldAccess c)
boolean	matchesFieldName(StringBuilder sb, net.openhft.chronicle.wire.WireMarshaller.FieldAccess field)
static <T> @NotNull WireMarshaller<T>	of(@NotNull Class<T> tClass)
void	readMarshallable(T t, @NotNull WireIn in, T defaults, boolean overwrite) Reads and populates the DTO based on the provided input.
void	readMarshallableDTOOrder(T t, @NotNull WireIn in, T defaults, boolean overwrite) Reads and populates the DTO based on the provided order.
void	readMarshallableInputOrder(T t, @NotNull WireIn in, T defaults, boolean overwrite) Reads and populates the DTO based on the input's order.
void	reset(T o)
void	setField(Object o, String name, Object value)
void	setLongField(Object o, String name, long value)
void	writeKey(T t, net.openhft.chronicle.bytes.Bytes<?> bytes)
void	writeMarshallable(T t, net.openhft.chronicle.bytes.Bytes<?> bytes)
void	writeMarshallable(T t, @NotNull WireOut out)
void	writeMarshallable(T t, @NotNull WireOut out, T previous, boolean copy) Writes the values of the fields from the provided object (DTO) to the output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WIRE_MARSHALLER_CL

public static final net.openhft.chronicle.core.ClassLocal<WireMarshaller> WIRE_MARSHALLER_CL

Constructor Detail

WireMarshaller

protected WireMarshaller(@NotNull
                         @NotNull Class<T> tClass,
                         @NotNull
                         @NotNull net.openhft.chronicle.wire.WireMarshaller.FieldAccess[] fields,
                         boolean isLeaf)

Method Detail

of

@NotNull
public static <T> @NotNull WireMarshaller<T> of(@NotNull
                                                         @NotNull Class<T> tClass)

leafable

protected static boolean leafable(net.openhft.chronicle.wire.WireMarshaller.FieldAccess c)

getAllField

public static void getAllField(@NotNull
                               @NotNull Class clazz,
                               @NotNull
                               @NotNull Map<String,Field> map)

excludeFields

public WireMarshaller<T> excludeFields(String... fieldNames)

writeMarshallable

public void writeMarshallable(T t,
                              @NotNull
                              @NotNull WireOut out)
                       throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

writeMarshallable

public void writeMarshallable(T t,
                              net.openhft.chronicle.bytes.Bytes<?> bytes)

writeMarshallable

public void writeMarshallable(T t,
                              @NotNull
                              @NotNull WireOut out,
                              T previous,
                              boolean copy)
                       throws net.openhft.chronicle.core.io.InvalidMarshallableException

Writes the values of the fields from the provided object (DTO) to the output. Before writing, the object is validated. The method also supports optional copying of the values from the source object to a previous instance.

Parameters:

t - Object whose field values are to be written.

out - Output destination where the field values are written to.

previous - Previous object to compare for optional copying.

copy - Flag indicating whether to copy values from the source object to the previous object.

Throws:

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

readMarshallable

public void readMarshallable(T t,
                             @NotNull
                             @NotNull WireIn in,
                             T defaults,
                             boolean overwrite)
                      throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads and populates the DTO based on the provided input. The input order can be hinted. After reading, the object is validated.

Parameters:

t - Object to populate with read values.

in - Input source from which values are read.

defaults - Default values to use if a value isn't provided in the input.

overwrite - Flag indicating whether to overwrite the existing value in the target object.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If there is an error during marshalling.

readMarshallableDTOOrder

public void readMarshallableDTOOrder(T t,
                                     @NotNull
                                     @NotNull WireIn in,
                                     T defaults,
                                     boolean overwrite)
                              throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads and populates the DTO based on the provided order.

Parameters:

t - Target object to populate with read values.

in - Input source from which values are read.

defaults - Default values to use if a value isn't provided in the input.

overwrite - Flag indicating whether to overwrite the existing value in the target object.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If there is an error during marshalling.

readMarshallableInputOrder

public void readMarshallableInputOrder(T t,
                                       @NotNull
                                       @NotNull WireIn in,
                                       T defaults,
                                       boolean overwrite)
                                throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads and populates the DTO based on the input's order.

Parameters:

t - Target object to populate with read values.

in - Input source from which values are read.

defaults - Default values to use if a value isn't provided in the input.

overwrite - Flag indicating whether to overwrite the existing value in the target object.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If there is an error during marshalling.

matchesFieldName

public boolean matchesFieldName(StringBuilder sb,
                                net.openhft.chronicle.wire.WireMarshaller.FieldAccess field)

writeKey

public void writeKey(T t,
                     net.openhft.chronicle.bytes.Bytes<?> bytes)

isEqual

public boolean isEqual(Object o1,
                       Object o2)

getField

public Object getField(Object o,
                       String name)
                throws NoSuchFieldException

Throws:

NoSuchFieldException

getLongField

public long getLongField(@NotNull
                         @NotNull Object o,
                         String name)
                  throws NoSuchFieldException

Throws:

NoSuchFieldException

setField

public void setField(Object o,
                     String name,
                     Object value)
              throws NoSuchFieldException

Throws:

NoSuchFieldException

setLongField

public void setLongField(Object o,
                         String name,
                         long value)
                  throws NoSuchFieldException

Throws:

NoSuchFieldException

defaultValue

@Nullable
public T defaultValue()

reset

public void reset(T o)

isLeaf

public boolean isLeaf()