net.openhft.chronicle.wire

Interface ValueIn

All Known Implementing Classes:

BinaryWire.BinaryValueIn, DefaultValueIn, TextWire.TextValueIn

public interface ValueIn

Represents an interface for reading values in various formats from a serialized data source. This interface is part of the Chronicle Wire library, which is designed for high-performance serialization and deserialization of data. It provides methods to read data types like text, binary, numeric, and temporal values, as well as support for more complex types like collections and marshallable objects.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ValueIn.Reader Interface for reading values from the wire into a list.

Field Summary

Fields

Modifier and Type	Field and Description
static Consumer<ValueIn>	DISCARD A constant consumer that does nothing when accepting a ValueIn.

Method Summary

Modifier and Type	Method and Description
<T> T	applyToMarshallable(Function<WireIn,T> marshallableReader) Applies a Function to this ValueIn, interpreting it as a WireIn for a marshallable object.
default int	array(boolean[] array) Reads an array of boolean values from the wire, populating the provided array.
default int	array(byte[] array) Reads an array of byte values from the wire, populating the provided array.
default int	array(net.openhft.chronicle.bytes.Bytes[] array) Reads an array of Bytes objects from the wire, populating the provided array.
default int	array(double[] array) Reads an array of double values from the wire, populating the provided array.
default int	array(int[] array) Reads an array of int values from the wire, populating the provided array.
default int	array(long[] array) Reads an array of long values from the wire, populating the provided array.
default int	arrayDelta(double[] array) Reads an array of double values with delta compression from the wire, populating the provided array.
default int	arrayDelta(long[] array) Reads an array of long values with delta compression from the wire, populating the provided array.
default <E extends Enum<E>> E	asEnum(Class<E> eClass) Reads an Enum value of the specified type from the wire.
default <E extends Enum<E>> @NotNull WireIn	asEnum(Class<E> eClass, @NotNull Consumer<E> eConsumer) Reads an Enum value of the specified type from the wire and applies it to a Consumer.
default <E extends Enum<E>,T> @NotNull WireIn	asEnum(Class<E> eClass, T t, @NotNull BiConsumer<T,E> teConsumer) Reads an Enum value of the specified type from the wire and applies it to a given object using a BiConsumer.
boolean	bool() Reads a boolean value from the wire.
WireIn	bool(@NotNull net.openhft.chronicle.core.values.BooleanValue ret) Reads a boolean value and populates the provided BooleanValue.
<T> @NotNull WireIn	bool(T t, @NotNull net.openhft.chronicle.core.util.ObjBooleanConsumer<T> tFlag) Reads a boolean value and applies it to the provided consumer.
default void	byteBuffer(@NotNull ByteBuffer bb) Puts the byte data into the provided ByteBuffer.
default byte[]	bytes() Retrieves the byte data as an array.
byte[]	bytes(byte[] using) Retrieves the byte data as an array with the option to reuse an existing byte array.
@NotNull WireIn	bytes(@NotNull net.openhft.chronicle.bytes.BytesOut<?> toBytes) Reads byte data into the provided BytesOut object.
default WireIn	bytes(@NotNull net.openhft.chronicle.bytes.BytesOut<?> toBytes, boolean clearBytes) Reads byte data into the provided BytesOut object with an option to clear the BytesOut before reading.
@NotNull WireIn	bytes(@NotNull net.openhft.chronicle.bytes.ReadBytesMarshallable bytesMarshallable) Reads byte data using the provided ReadBytesMarshallable.
default @Nullable net.openhft.chronicle.bytes.BytesStore<?,?>	bytesLiteral() Retrieves the byte data as a BytesStore object.
default @NotNull WireIn	bytesLiteral(@NotNull net.openhft.chronicle.bytes.BytesOut<?> toBytes) Reads byte data into the provided BytesOut object.
@NotNull WireIn	bytesMatch(@NotNull net.openhft.chronicle.bytes.BytesStore<?,?> compareBytes, net.openhft.chronicle.core.util.BooleanConsumer consumer) Compares byte data with the provided BytesStore and uses the given BooleanConsumer based on the result.
@Nullable WireIn	bytesSet(@NotNull net.openhft.chronicle.bytes.PointerBytesStore toBytes) Sets byte data to the provided PointerBytesStore.
default @Nullable net.openhft.chronicle.bytes.BytesStore<?,?>	bytesStore() Retrieves the byte data as a BytesStore object.
default char	character() Reads text data and returns the first character.
net.openhft.chronicle.core.pool.ClassLookup	classLookup() Retrieves a ClassLookup instance associated with the current WireIn.
default <O,T extends ReadMarshallable> @NotNull WireIn	collection(O o, Function<O,T> tSupplier) Reads a sequence of ReadMarshallable items into a collection, where each item is constructed using the provided Function.
default <T,C extends Collection<T>> C	collection(@NotNull Supplier<C> supplier, Class<T> t) Reads a Collection of objects of a specified type from the wire, using the provided supplier for the Collection type.
default LocalDate	date() Reads a LocalDate directly from the wire.
<T> @NotNull WireIn	date(T t, @NotNull BiConsumer<T,LocalDate> tLocalDate) Reads a LocalDate from the wire and applies it to a given object using the provided BiConsumer.
default LocalDateTime	dateTime() Reads a LocalDateTime directly from the wire.
float	float32() Reads a 32-bit floating point number from the wire.
default float	float32(float previous) Reads a 32-bit floating-point (float) value from the wire with a previous value as a reference.
<T> @NotNull WireIn	float32(T t, @NotNull net.openhft.chronicle.core.util.ObjFloatConsumer<T> tf) Reads a 32-bit floating-point (float) value and applies an ObjFloatConsumer with the provided object and the read value.
double	float64() Reads a 64-bit floating point number from the wire.
default double	float64(double previous) Reads a 64-bit floating-point (double) value from the wire with a previous value as a reference.
<T> @NotNull WireIn	float64(T t, @NotNull ObjDoubleConsumer<T> td) Reads a 64-bit floating-point (double) value and applies an ObjDoubleConsumer with the provided object and the read value.
@NotNull BracketType	getBracketType() Gets the bracket type for the current value in the wire.
boolean	hasNext() Checks if there is another element to read in a sequence or collection.
boolean	hasNextSequenceItem() Checks if there is another item in a sequence.
default @NotNull WireIn	int128(@NotNull net.openhft.chronicle.core.values.TwoLongValue value) Reads a 128-bit integer value from the wire into the specified TwoLongValue.
short	int16() Reads a 16-bit integer (short) value from the wire.
<T> @NotNull WireIn	int16(T t, @NotNull net.openhft.chronicle.core.util.ObjShortConsumer<T> ti) Reads a 16-bit integer (short) value and applies an ObjShortConsumer with the provided object and the read value.
int	int32() Reads a 32-bit integer (int) value from the wire.
default int	int32(int previous) Reads a 32-bit integer (int) value from the wire with a previous value as a reference.
@NotNull WireIn	int32(@NotNull net.openhft.chronicle.core.values.IntValue value) Reads a 32-bit integer value from the wire into the specified IntValue.
<T> @NotNull WireIn	int32(@Nullable net.openhft.chronicle.core.values.IntValue value, T t, @NotNull BiConsumer<T,net.openhft.chronicle.core.values.IntValue> setter) Reads a 32-bit signed integer, populates the IntValue, and applies the IntValue using the provided consumer.
<T> @NotNull WireIn	int32(T t, @NotNull ObjIntConsumer<T> ti) Reads a 32-bit integer (int) value and applies an ObjIntConsumer with the provided object and the read value.
long	int64() Reads a 64-bit integer (long) value from the wire.
default long	int64(long previous) Reads a 64-bit integer (long) value from the wire with a previous value as a reference.
@NotNull WireIn	int64(@NotNull net.openhft.chronicle.core.values.LongValue value) Reads a 64-bit integer value from the wire into the specified LongValue.
<T> @NotNull WireIn	int64(@Nullable net.openhft.chronicle.core.values.LongValue value, T t, @NotNull BiConsumer<T,net.openhft.chronicle.core.values.LongValue> setter) Reads a 64-bit signed integer, populates the LongValue, and applies the LongValue using the provided consumer.
<T> @NotNull WireIn	int64(T t, @NotNull ObjLongConsumer<T> tl) Reads a 64-bit integer (long) value and applies an ObjLongConsumer with the provided object and the read value.
<T> @NotNull WireIn	int64array(@Nullable net.openhft.chronicle.core.values.LongArrayValues values, T t, @NotNull BiConsumer<T,net.openhft.chronicle.core.values.LongArrayValues> setter) Reads a LongArrayValues from the wire and applies it to a given object using the provided BiConsumer.
default @NotNull net.openhft.chronicle.core.values.LongValue	int64ForBinding(@Nullable net.openhft.chronicle.core.values.LongValue value) Reads a 64-bit integer for binding.
byte	int8() Reads an 8-bit integer (byte) value from the wire.
<T> @NotNull WireIn	int8(T t, @NotNull net.openhft.chronicle.core.util.ObjByteConsumer<T> tb) Reads an 8-bit integer (byte) value and applies an ObjByteConsumer with the provided object and the read value.
default boolean	isBinary() Checks if the current value in the wire is binary.
boolean	isNull() Checks if the current value in the wire is null.
default boolean	isPresent() Checks if a value is present in the data stream.
boolean	isTyped() Checks if the current value in the wire is typed.
default @Nullable Type	lenientTypeLiteral() Reads a type literal from the wire, returning it as a Type object, with a fallback for unresolved types.
default <T> List<T>	list(Class<T> t) Reads a List of objects of a specified type from the wire.
default <O,T extends ReadMarshallable> @NotNull WireIn	list(O o, Function<O,T> tSupplier) Reads a List of ReadMarshallable objects from the wire, and applies them to a provided object using the function.
@Nullable Object	marshallable(@NotNull Object object, @NotNull SerializationStrategy strategy) Reads a marshallable object from the wire and applies a specified SerializationStrategy.
default boolean	marshallable(@NotNull ReadMarshallable object) Reads a ReadMarshallable object from the wire.
default boolean	marshallable(@NotNull Serializable object) Reads a Serializable object from the wire.
default <K,V> @Nullable Map<K,V>	marshallableAsMap(Class<K> kClass, @NotNull Class<V> vClass) Reads a Map of marshallable key-value pairs as specified by the provided classes.
default <K,V> @Nullable Map<K,V>	marshallableAsMap(Class<K> kClass, @NotNull Class<V> vClass, @NotNull Map<K,V> map) Reads a Map of marshallable key-value pairs into the provided Map.
default @Nullable Object	object()
default <E> E	object(@Nullable Class<E> clazz) Reads an object of the specified class from the wire.
default <T,E> @Nullable WireIn	object(@NotNull Class<E> clazz, T t, @NotNull BiConsumer<T,E> e) Reads an object of a specified class from the wire and applies it to a given object using a BiConsumer.
default <E> E	object(E using, @Nullable Class<? extends E> clazz) Reads an object from the wire.
default <E> E	object(E using, @Nullable Class<? extends E> clazz, boolean bestEffort) Reads an object from the wire.
default Object	objectBestEffort() Deserializes an object from the current data stream, attempting to return any object that can be parsed.
@Nullable Object	objectWithInferredType(Object using, SerializationStrategy strategy, Class<?> type) Reads an object from the wire with an inferred type.
default boolean	readBoolean() Reads a boolean value from the wire.
default byte	readByte() Reads a byte value from the wire.
default char	readChar() Reads a char value from the wire.
default double	readDouble() Reads a double value from the wire.
default <T> void	reader0(ValueIn v, List<T> list, List<T> buffer, Supplier<T> bufferAdd) Helper method to read a sequence of values into a list using a buffer.
default float	readFloat() Reads a float value from the wire.
default int	readInt() Reads an int value from the wire.
long	readLength() Retrieves the length of the field in bytes, inclusive of any encoding and header character.
default long	readLong() Reads a long value from the wire.
default long	readLong(LongConverter longConverter) Reads a long value from the wire using a LongConverter.
default short	readShort() Reads a short value from the wire.
default String	readString() Reads a String from the wire.
void	resetState() Resets the internal state of this ValueIn.
default <T> boolean	sequence(@NotNull List<T> list, @NotNull List<T> buffer, @NotNull Supplier<T> bufferAdd) sequence to use when using a cached buffer
<T> boolean	sequence(List<T> list, @NotNull List<T> buffer, Supplier<T> bufferAdd, ValueIn.Reader reader0) Processes a sequence of values from the wire, storing them in a list.
<T> boolean	sequence(T t, @NotNull BiConsumer<T,ValueIn> tReader) Reads a sequence of values using the provided consumer.
<T,K> @NotNull WireIn	sequence(T t, K k, @NotNull TriConsumer<T,K,ValueIn> tReader) Processes a sequence of values from the wire, applying a TriConsumer to each item in the sequence.
default <T> boolean	sequence(T t, @NotNull SerializationStrategy tReader) Processes a sequence of values from the wire using a SerializationStrategy.
default <T> int	sequenceWithLength(T t, @NotNull ToIntBiFunction<ValueIn,T> tReader) Reads a sequence of values and applies a function that returns the length of the sequence.
default <T> Set<T>	set(Class<T> t) Reads a Set of objects of a specified type from the wire.
default <O,T extends ReadMarshallable> @NotNull WireIn	set(O o, Function<O,T> tSupplier) Reads a Set of ReadMarshallable objects from the wire, and applies them to a provided object using the function.
@NotNull WireIn	skipValue() Skips the current value while reading.
@Nullable String	text() Reads and returns the text data.
default @NotNull WireIn	text(@NotNull net.openhft.chronicle.bytes.Bytes<?> sdo) Reads text data into the provided Bytes object, which is then cleared.
default @NotNull WireIn	text(@NotNull StringBuilder sb) Reads text data and appends it to the given StringBuilder.
default <T> @NotNull WireIn	text(T t, @NotNull BiConsumer<T,String> ts) Reads text data and applies a given bi-consumer to the text data and the provided object.
@Nullable net.openhft.chronicle.bytes.Bytes<?>	textTo(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes) Reads text data into the provided Bytes object.
@Nullable StringBuilder	textTo(@NotNull StringBuilder sb) Reads text data and appends it to the given StringBuilder.
default Throwable	throwable(boolean appendCurrentStack) Reads a Throwable from the wire, optionally appending the current stack trace.
default LocalTime	time() Reads a LocalTime directly from the wire.
<T> @NotNull WireIn	time(T t, @NotNull BiConsumer<T,LocalTime> setLocalTime)
<T> T	typedMarshallable() Reads a typed marshallable object from the wire.
default <T> T	typedMarshallable(@NotNull Function<Class<T>,ReadMarshallable> marshallableFunction) Reads a typed marshallable object from the wire, using the provided function to create instances.
default <T> @Nullable Class<T>	typeLiteral() Reads a Class type literal from the wire.
Type	typeLiteral(BiFunction<CharSequence,ClassNotFoundException,Type> unresolvedHandler) Reads a type literal from the wire, applying a handler for unresolved types.
default <T> @NotNull WireIn	typeLiteral(T t, @NotNull BiConsumer<T,Class> classConsumer) Reads a type literal as text and applies it to a given object using the provided BiConsumer.
default <T> @NotNull WireIn	typeLiteral(T t, @NotNull BiConsumer<T,Class> classConsumer, Class<?> defaultClass) Reads a type literal from the wire, applies it to a given object using the provided BiConsumer, and uses a default Class if necessary.
<T> @NotNull WireIn	typeLiteralAsText(T t, @NotNull BiConsumer<T,CharSequence> classNameConsumer) Consumes a type literal (a class name) as text from the wire, passing it to a consumer.
@Nullable Class<?>	typePrefix() Reads the type prefix from the wire.
<T> @NotNull ValueIn	typePrefix(T t, @NotNull BiConsumer<T,CharSequence> ts) Reads a type prefix and applies it to a given object using the provided BiConsumer.
default @Nullable Object	typePrefixOrObject(Class<?> tClass) read a class with a super class or actual class as a hint
int	uint16() Reads an unsigned 16-bit integer (represented as an int) from the wire.
<T> @NotNull WireIn	uint16(T t, @NotNull ObjIntConsumer<T> ti) Reads an unsigned 16-bit integer (int) value and applies an ObjIntConsumer with the provided object and the read value.
<T> @NotNull WireIn	uint32(T t, @NotNull ObjLongConsumer<T> tl) Reads an unsigned 32-bit integer (long) value and applies an ObjLongConsumer with the provided object and the read value.
<T> @NotNull WireIn	uint8(T t, @NotNull net.openhft.chronicle.core.util.ObjShortConsumer<T> ti) Reads an unsigned 8-bit integer (short) value and applies an ObjShortConsumer with the provided object and the read value.
default @NotNull UUID	uuid() Reads a UUID from the wire.
<T> @NotNull WireIn	uuid(T t, @NotNull BiConsumer<T,UUID> tuuid) Reads a UUID from the wire and applies it to a given object using the provided BiConsumer.
@NotNull WireIn	wireIn() Provides the current WireIn instance.
default ZonedDateTime	zonedDateTime() Reads a ZonedDateTime directly from the wire.
<T> @NotNull WireIn	zonedDateTime(T t, @NotNull BiConsumer<T,ZonedDateTime> tZonedDateTime) Reads a ZonedDateTime from the wire and applies it to a given object using the provided BiConsumer.

Field Detail

DISCARD

static final Consumer<ValueIn> DISCARD

A constant consumer that does nothing when accepting a ValueIn.

Method Detail

text

@NotNull
default <T> @NotNull WireIn text(T t,
                                          @NotNull
                                          @NotNull BiConsumer<T,String> ts)

Reads text data and applies a given bi-consumer to the text data and the provided object.

Type Parameters:

T - Type of the target object.

Parameters:

t - The target object.

ts - The bi-consumer that accepts the target object and the read text.

Returns:

The current WireIn instance.

text

@NotNull
default @NotNull WireIn text(@NotNull
                                      @NotNull StringBuilder sb)

Reads text data and appends it to the given StringBuilder. If the data is null, the StringBuilder is cleared.

Parameters:

sb - The StringBuilder to append the text data to.

Returns:

The current WireIn instance.

character

default char character()

Reads text data and returns the first character. If the data is null or empty, a null character is returned.

Returns:

The first character of the text data or '' if none.

text

@NotNull
default @NotNull WireIn text(@NotNull
                                      @NotNull net.openhft.chronicle.bytes.Bytes<?> sdo)

Reads text data into the provided Bytes object, which is then cleared.

Parameters:

sdo - The Bytes object to store the text data.

Returns:

The current WireIn instance.

text

@Nullable
@Nullable String text()

Reads and returns the text data.

Returns:

The text data or null.

textTo

@Nullable
@Nullable StringBuilder textTo(@NotNull
                                         @NotNull StringBuilder sb)

Reads text data and appends it to the given StringBuilder.

Parameters:

sb - The StringBuilder to append the text data to.

Returns:

The StringBuilder with appended text or null.

textTo

@Nullable
@Nullable net.openhft.chronicle.bytes.Bytes<?> textTo(@NotNull
                                                                @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)

Reads text data into the provided Bytes object.

Parameters:

bytes - The Bytes object to store the text data.

Returns:

The Bytes object with the text data or null.

bytes

@NotNull
@NotNull WireIn bytes(@NotNull
                               @NotNull net.openhft.chronicle.bytes.BytesOut<?> toBytes)

Reads byte data into the provided BytesOut object.

Parameters:

toBytes - The BytesOut object to store the byte data.

Returns:

The current WireIn instance.

bytes

default WireIn bytes(@NotNull
                     @NotNull net.openhft.chronicle.bytes.BytesOut<?> toBytes,
                     boolean clearBytes)

Reads byte data into the provided BytesOut object with an option to clear the BytesOut before reading.

Parameters:

toBytes - The BytesOut object to store the byte data.

clearBytes - If true, the BytesOut object will be cleared before reading.

Returns:

The current WireIn instance.

bytesLiteral

@NotNull
default @NotNull WireIn bytesLiteral(@NotNull
                                              @NotNull net.openhft.chronicle.bytes.BytesOut<?> toBytes)

Reads byte data into the provided BytesOut object. This method acts as a semantic alias for bytes(BytesOut) method.

Parameters:

toBytes - The BytesOut object to store the byte data.

Returns:

The current WireIn instance.

bytesLiteral

@Nullable
default @Nullable net.openhft.chronicle.bytes.BytesStore<?,?> bytesLiteral()

Retrieves the byte data as a BytesStore object. This method acts as a semantic alias for bytesStore() method.

Returns:

The BytesStore object or null.

bytesSet

@Nullable
@Nullable WireIn bytesSet(@NotNull
                                    @NotNull net.openhft.chronicle.bytes.PointerBytesStore toBytes)

Sets byte data to the provided PointerBytesStore.

Parameters:

toBytes - The PointerBytesStore to set the byte data.

Returns:

The current WireIn instance.

bytesMatch

@NotNull
@NotNull WireIn bytesMatch(@NotNull
                                    @NotNull net.openhft.chronicle.bytes.BytesStore<?,?> compareBytes,
                                    net.openhft.chronicle.core.util.BooleanConsumer consumer)

Compares byte data with the provided BytesStore and uses the given BooleanConsumer based on the result.

Parameters:

compareBytes - The BytesStore to compare with.

consumer - The BooleanConsumer to be called based on the comparison result.

Returns:

The current WireIn instance.

bytes

@NotNull
@NotNull WireIn bytes(@NotNull
                               @NotNull net.openhft.chronicle.bytes.ReadBytesMarshallable bytesMarshallable)

Reads byte data using the provided ReadBytesMarshallable.

Parameters:

bytesMarshallable - The ReadBytesMarshallable to read the byte data.

Returns:

The current WireIn instance.

bytes

default byte[] bytes()

Retrieves the byte data as an array.

Returns:

The byte data as an array or null.

bytes

byte[] bytes(byte[] using)

Retrieves the byte data as an array with the option to reuse an existing byte array.

Parameters:

using - The existing byte array to use or null.

Returns:

The byte data as an array or null.

bytesStore

@Nullable
default @Nullable net.openhft.chronicle.bytes.BytesStore<?,?> bytesStore()

Retrieves the byte data as a BytesStore object.

Returns:

The BytesStore object or null.

byteBuffer

default void byteBuffer(@NotNull
                        @NotNull ByteBuffer bb)

Puts the byte data into the provided ByteBuffer.

Parameters:

bb - The ByteBuffer to put the byte data.

wireIn

@NotNull
@NotNull WireIn wireIn()

Provides the current WireIn instance.

Returns:

The current WireIn instance.

readLength

long readLength()

Retrieves the length of the field in bytes, inclusive of any encoding and header character.

Returns:

The length of the field in bytes.

skipValue

@NotNull
@NotNull WireIn skipValue()

Skips the current value while reading.

Returns:

The current WireIn instance.

bool

@NotNull
<T> @NotNull WireIn bool(T t,
                                  @NotNull
                                  @NotNull net.openhft.chronicle.core.util.ObjBooleanConsumer<T> tFlag)

Reads a boolean value and applies it to the provided consumer.

Type Parameters:

T - The type of the target object.

Parameters:

t - The target object.

tFlag - The consumer that accepts the target object and the read boolean value.

Returns:

The current WireIn instance.

int8

@NotNull
<T> @NotNull WireIn int8(@NotNull
                                  T t,
                                  @NotNull
                                  @NotNull net.openhft.chronicle.core.util.ObjByteConsumer<T> tb)

Reads an 8-bit integer (byte) value and applies an ObjByteConsumer with the provided object and the read value.

Type Parameters:

T - The type of object to be passed to the ObjByteConsumer.

Parameters:

t - The object to be passed to the ObjByteConsumer.

tb - The ObjByteConsumer that accepts the object and the read 8-bit integer value.

Returns:

The WireIn instance for method chaining.

uint8

@NotNull
<T> @NotNull WireIn uint8(@NotNull
                                   T t,
                                   @NotNull
                                   @NotNull net.openhft.chronicle.core.util.ObjShortConsumer<T> ti)

Reads an unsigned 8-bit integer (short) value and applies an ObjShortConsumer with the provided object and the read value.

Type Parameters:

T - The type of object to be passed to the ObjShortConsumer.

Parameters:

t - The object to be passed to the ObjShortConsumer.

ti - The ObjShortConsumer that accepts the object and the read unsigned 8-bit integer value.

Returns:

The WireIn instance for method chaining.

int16

@NotNull
<T> @NotNull WireIn int16(@NotNull
                                   T t,
                                   @NotNull
                                   @NotNull net.openhft.chronicle.core.util.ObjShortConsumer<T> ti)

Reads a 16-bit integer (short) value and applies an ObjShortConsumer with the provided object and the read value.

Type Parameters:

T - The type of object to be passed to the ObjShortConsumer.

Parameters:

t - The object to be passed to the ObjShortConsumer.

ti - The ObjShortConsumer that accepts the object and the read 16-bit integer value.

Returns:

The WireIn instance for method chaining.

uint16

@NotNull
<T> @NotNull WireIn uint16(@NotNull
                                    T t,
                                    @NotNull
                                    @NotNull ObjIntConsumer<T> ti)

Reads an unsigned 16-bit integer (int) value and applies an ObjIntConsumer with the provided object and the read value.

Type Parameters:

T - The type of object to be passed to the ObjIntConsumer.

Parameters:

t - The object to be passed to the ObjIntConsumer.

ti - The ObjIntConsumer that accepts the object and the read unsigned 16-bit integer value.

Returns:

The WireIn instance for method chaining.

int32

@NotNull
<T> @NotNull WireIn int32(@NotNull
                                   T t,
                                   @NotNull
                                   @NotNull ObjIntConsumer<T> ti)

Reads a 32-bit integer (int) value and applies an ObjIntConsumer with the provided object and the read value.

Type Parameters:

T - The type of object to be passed to the ObjIntConsumer.

Parameters:

t - The object to be passed to the ObjIntConsumer.

ti - The ObjIntConsumer that accepts the object and the read 32-bit integer value.

Returns:

The WireIn instance for method chaining.

uint32

@NotNull
<T> @NotNull WireIn uint32(@NotNull
                                    T t,
                                    @NotNull
                                    @NotNull ObjLongConsumer<T> tl)

Reads an unsigned 32-bit integer (long) value and applies an ObjLongConsumer with the provided object and the read value.

Type Parameters:

T - The type of object to be passed to the ObjLongConsumer.

Parameters:

t - The object to be passed to the ObjLongConsumer.

tl - The ObjLongConsumer that accepts the object and the read unsigned 32-bit integer value.

Returns:

The WireIn instance for method chaining.

int64

@NotNull
<T> @NotNull WireIn int64(@NotNull
                                   T t,
                                   @NotNull
                                   @NotNull ObjLongConsumer<T> tl)

Reads a 64-bit integer (long) value and applies an ObjLongConsumer with the provided object and the read value.

Type Parameters:

T - The type of object to be passed to the ObjLongConsumer.

Parameters:

t - The object to be passed to the ObjLongConsumer.

tl - The ObjLongConsumer that accepts the object and the read 64-bit integer value.

Returns:

The WireIn instance for method chaining.

float32

@NotNull
<T> @NotNull WireIn float32(@NotNull
                                     T t,
                                     @NotNull
                                     @NotNull net.openhft.chronicle.core.util.ObjFloatConsumer<T> tf)

Reads a 32-bit floating-point (float) value and applies an ObjFloatConsumer with the provided object and the read value.

Type Parameters:

T - The type of object to be passed to the ObjFloatConsumer.

Parameters:

t - The object to be passed to the ObjFloatConsumer.

tf - The ObjFloatConsumer that accepts the object and the read 32-bit floating-point value.

Returns:

The WireIn instance for method chaining.

float64

@NotNull
<T> @NotNull WireIn float64(@NotNull
                                     T t,
                                     @NotNull
                                     @NotNull ObjDoubleConsumer<T> td)

Reads a 64-bit floating-point (double) value and applies an ObjDoubleConsumer with the provided object and the read value.

Type Parameters:

T - The type of object to be passed to the ObjDoubleConsumer.

Parameters:

t - The object to be passed to the ObjDoubleConsumer.

td - The ObjDoubleConsumer that accepts the object and the read 64-bit floating-point value.

Returns:

The WireIn instance for method chaining.

time

@NotNull
<T> @NotNull WireIn time(@NotNull
                                  T t,
                                  @NotNull
                                  @NotNull BiConsumer<T,LocalTime> setLocalTime)

zonedDateTime

@NotNull
<T> @NotNull WireIn zonedDateTime(@NotNull
                                           T t,
                                           @NotNull
                                           @NotNull BiConsumer<T,ZonedDateTime> tZonedDateTime)

Reads a ZonedDateTime from the wire and applies it to a given object using the provided BiConsumer.

Type Parameters:

T - The type of object to be passed to the BiConsumer.

Parameters:

t - The object to be passed to the BiConsumer.

tZonedDateTime - The BiConsumer that accepts the object and the read ZonedDateTime.

Returns:

The WireIn instance for method chaining.

date

@NotNull
<T> @NotNull WireIn date(@NotNull
                                  T t,
                                  @NotNull
                                  @NotNull BiConsumer<T,LocalDate> tLocalDate)

Reads a LocalDate from the wire and applies it to a given object using the provided BiConsumer.

Type Parameters:

T - The type of object to be passed to the BiConsumer.

Parameters:

t - The object to be passed to the BiConsumer.

tLocalDate - The BiConsumer that accepts the object and the read LocalDate.

Returns:

The WireIn instance for method chaining.

date

default LocalDate date()

Reads a LocalDate directly from the wire.

Returns:

The LocalDate read from the wire.

time

default LocalTime time()

Reads a LocalTime directly from the wire.

Returns:

The LocalTime read from the wire.

dateTime

default LocalDateTime dateTime()

Reads a LocalDateTime directly from the wire.

Returns:

The LocalDateTime read from the wire.

zonedDateTime

default ZonedDateTime zonedDateTime()

Reads a ZonedDateTime directly from the wire.

Returns:

The ZonedDateTime read from the wire.

hasNext

boolean hasNext()

Checks if there is another element to read in a sequence or collection.

Returns:

True if there is another element to read, false otherwise.

hasNextSequenceItem

boolean hasNextSequenceItem()

Checks if there is another item in a sequence.

Returns:

True if there is another sequence item, false otherwise.

uuid

@NotNull
<T> @NotNull WireIn uuid(@NotNull
                                  T t,
                                  @NotNull
                                  @NotNull BiConsumer<T,UUID> tuuid)

Reads a UUID from the wire and applies it to a given object using the provided BiConsumer.

Type Parameters:

T - The type of object to be passed to the BiConsumer.

Parameters:

t - The object to be passed to the BiConsumer.

tuuid - The BiConsumer that accepts the object and the read UUID.

Returns:

The WireIn instance for method chaining.

int64array

@NotNull
<T> @NotNull WireIn int64array(@Nullable
                                        @Nullable net.openhft.chronicle.core.values.LongArrayValues values,
                                        T t,
                                        @NotNull
                                        @NotNull BiConsumer<T,net.openhft.chronicle.core.values.LongArrayValues> setter)

Reads a LongArrayValues from the wire and applies it to a given object using the provided BiConsumer.

Type Parameters:

T - The type of object to be passed to the BiConsumer.

Parameters:

values - The LongArrayValues to read the data into.

t - The object to be passed to the BiConsumer.

setter - The BiConsumer that accepts the object and the LongArrayValues.

Returns:

The WireIn instance for method chaining.

int128

@NotNull
default @NotNull WireIn int128(@NotNull
                                        @NotNull net.openhft.chronicle.core.values.TwoLongValue value)

Reads a 128-bit integer value from the wire into the specified TwoLongValue.

Parameters:

value - The TwoLongValue to read the 128-bit integer into.

Returns:

The WireIn instance for method chaining.

int64

@NotNull
@NotNull WireIn int64(@NotNull
                               @NotNull net.openhft.chronicle.core.values.LongValue value)

Reads a 64-bit integer value from the wire into the specified LongValue.

Parameters:

value - The LongValue to read the 64-bit integer into.

Returns:

The WireIn instance for method chaining.

int32

@NotNull
@NotNull WireIn int32(@NotNull
                               @NotNull net.openhft.chronicle.core.values.IntValue value)

Reads a 32-bit integer value from the wire into the specified IntValue.

Parameters:

value - The IntValue to read the 32-bit integer into.

Returns:

The WireIn instance for method chaining.

int64ForBinding

@NotNull
default @NotNull net.openhft.chronicle.core.values.LongValue int64ForBinding(@Nullable
                                                                                      @Nullable net.openhft.chronicle.core.values.LongValue value)

Reads a 64-bit integer for binding. If the provided LongValue is null, creates a new reference.

Parameters:

value - The LongValue to be populated or null.

Returns:

The populated or newly created LongValue.

bool

WireIn bool(@NotNull
            @NotNull net.openhft.chronicle.core.values.BooleanValue ret)

Reads a boolean value and populates the provided BooleanValue.

Parameters:

ret - The BooleanValue to be populated.

Returns:

The current WireIn instance.

int64

@NotNull
<T> @NotNull WireIn int64(@Nullable
                                   @Nullable net.openhft.chronicle.core.values.LongValue value,
                                   T t,
                                   @NotNull
                                   @NotNull BiConsumer<T,net.openhft.chronicle.core.values.LongValue> setter)

Reads a 64-bit signed integer, populates the LongValue, and applies the LongValue using the provided consumer.

Type Parameters:

T - The type of the target object.

Parameters:

value - The LongValue to be populated.

t - The target object.

setter - The consumer that accepts the target object and the populated LongValue.

Returns:

The current WireIn instance.

int32

@NotNull
<T> @NotNull WireIn int32(@Nullable
                                   @Nullable net.openhft.chronicle.core.values.IntValue value,
                                   T t,
                                   @NotNull
                                   @NotNull BiConsumer<T,net.openhft.chronicle.core.values.IntValue> setter)

Reads a 32-bit signed integer, populates the IntValue, and applies the IntValue using the provided consumer.

Type Parameters:

T - The type of the target object.

Parameters:

value - The IntValue to be populated.

t - The target object.

setter - The consumer that accepts the target object and the populated IntValue.

Returns:

The current WireIn instance.

sequence

<T> boolean sequence(@NotNull
                     T t,
                     @NotNull
                     @NotNull BiConsumer<T,ValueIn> tReader)

Reads a sequence of values using the provided consumer.

Type Parameters:

T - The type of the target object.

Parameters:

t - The target object.

tReader - The consumer that reads the sequence into the target object.

Returns:

A boolean indicating if the sequence reading was successful.

sequence

<T> boolean sequence(List<T> list,
                     @NotNull
                     @NotNull List<T> buffer,
                     Supplier<T> bufferAdd,
                     ValueIn.Reader reader0)
              throws net.openhft.chronicle.core.io.InvalidMarshallableException

Processes a sequence of values from the wire, storing them in a list. It uses a buffer to minimize object creation.

Parameters:

list - The list to store the processed items.

buffer - The buffer for reusing objects.

bufferAdd - Supplier to provide new instances for the buffer.

reader0 - The reader that processes each item in the sequence.

Returns:

True if the sequence was processed, false otherwise.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

sequence

default <T> boolean sequence(@NotNull
                             T t,
                             @NotNull
                             @NotNull SerializationStrategy tReader)
                      throws net.openhft.chronicle.core.io.InvalidMarshallableException

Processes a sequence of values from the wire using a SerializationStrategy.

Type Parameters:

T - The type of the object to be processed.

Parameters:

t - The object to be processed.

tReader - The SerializationStrategy to process the object.

Returns:

True if the sequence was processed, false otherwise.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

reader0

default <T> void reader0(ValueIn v,
                         List<T> list,
                         List<T> buffer,
                         Supplier<T> bufferAdd)
                  throws net.openhft.chronicle.core.io.InvalidMarshallableException

Helper method to read a sequence of values into a list using a buffer.

Parameters:

v - The ValueIn to read from.

list - The list to store the read values.

buffer - The buffer for reusing objects.

bufferAdd - Supplier to provide new instances for the buffer.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

sequence

default <T> boolean sequence(@NotNull
                             @NotNull List<T> list,
                             @NotNull
                             @NotNull List<T> buffer,
                             @NotNull
                             @NotNull Supplier<T> bufferAdd)
                      throws net.openhft.chronicle.core.io.InvalidMarshallableException

sequence to use when using a cached buffer

Parameters:

list - of items to populate

buffer - of objects of the same type to reuse

bufferAdd - supplier to call when the buffer needs extending

Returns:

true if there is any data.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

sequence

@NotNull
<T,K> @NotNull WireIn sequence(@NotNull
                                        T t,
                                        K k,
                                        @NotNull
                                        @NotNull TriConsumer<T,K,ValueIn> tReader)
                                 throws net.openhft.chronicle.core.io.InvalidMarshallableException

Processes a sequence of values from the wire, applying a TriConsumer to each item in the sequence.

Type Parameters:

T - The type of the first object to be passed to the TriConsumer.

K - The type of the second object to be passed to the TriConsumer.

Parameters:

t - The first object to be passed to the TriConsumer.

k - The second object to be passed to the TriConsumer.

tReader - The TriConsumer that processes each item in the sequence.

Returns:

The WireIn instance for method chaining.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

sequenceWithLength

default <T> int sequenceWithLength(@NotNull
                                   T t,
                                   @NotNull
                                   @NotNull ToIntBiFunction<ValueIn,T> tReader)

Reads a sequence of values and applies a function that returns the length of the sequence.

Type Parameters:

T - The type of the target object.

Parameters:

t - The target object.

tReader - A function that accepts a ValueIn reader and the target object and returns the length.

Returns:

The length of the sequence.

array

default int array(net.openhft.chronicle.bytes.Bytes[] array)

Reads an array of Bytes objects from the wire, populating the provided array.

Parameters:

array - The array of Bytes objects to be populated.

Returns:

The number of Bytes objects read and populated.

array

default int array(double[] array)

Reads an array of double values from the wire, populating the provided array.

Parameters:

array - The array of double values to be populated.

Returns:

The number of double values read and populated.

arrayDelta

default int arrayDelta(double[] array)

Reads an array of double values with delta compression from the wire, populating the provided array.

Parameters:

array - The array of double values to be populated.

Returns:

The number of double values read and populated.

array

default int array(boolean[] array)

Reads an array of boolean values from the wire, populating the provided array.

Parameters:

array - The array of boolean values to be populated.

Returns:

The number of boolean values read and populated.

array

default int array(long[] array)

Reads an array of long values from the wire, populating the provided array.

Parameters:

array - The array of long values to be populated.

Returns:

The number of long values read and populated.

arrayDelta

default int arrayDelta(long[] array)

Reads an array of long values with delta compression from the wire, populating the provided array.

Parameters:

array - The array of long values to be populated.

Returns:

The number of long values read and populated.

array

default int array(int[] array)

Reads an array of int values from the wire, populating the provided array.

Parameters:

array - The array of int values to be populated.

Returns:

The number of int values read and populated.

array

default int array(byte[] array)

Reads an array of byte values from the wire, populating the provided array.

Parameters:

array - The array of byte values to be populated.

Returns:

The number of byte values read and populated.

set

default <T> Set<T> set(Class<T> t)
                throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a Set of objects of a specified type from the wire.

Type Parameters:

T - The type of objects in the Set.

Parameters:

t - The Class object representing the type T.

Returns:

A Set containing objects of type T, or throws InvalidMarshallableException in case of an error.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

list

default <T> List<T> list(Class<T> t)
                  throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a List of objects of a specified type from the wire.

Type Parameters:

T - The type of objects in the List.

Parameters:

t - The Class object representing the type T.

Returns:

A List containing objects of type T, or throws InvalidMarshallableException in case of an error.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

collection

default <T,C extends Collection<T>> C collection(@NotNull
                                                 @NotNull Supplier<C> supplier,
                                                 Class<T> t)
                                          throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a Collection of objects of a specified type from the wire, using the provided supplier for the Collection type.

Type Parameters:

T - The type of objects in the Collection.

C - The type of the Collection.

Parameters:

supplier - A Supplier providing instances of the Collection type C.

t - The Class object representing the type T.

Returns:

A Collection containing objects of type T, or throws InvalidMarshallableException in case of an error.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

set

@NotNull
default <O,T extends ReadMarshallable> @NotNull WireIn set(@NotNull
                                                                    O o,
                                                                    Function<O,T> tSupplier)
                                                             throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a Set of ReadMarshallable objects from the wire, and applies them to a provided object using the function.

Type Parameters:

O - The type of the object to apply the Set to.

T - The type of the ReadMarshallable objects.

Parameters:

o - The object to apply the Set to.

tSupplier - A Function providing instances of type T.

Returns:

The WireIn instance for method chaining.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

list

@NotNull
default <O,T extends ReadMarshallable> @NotNull WireIn list(@NotNull
                                                                     O o,
                                                                     Function<O,T> tSupplier)
                                                              throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a List of ReadMarshallable objects from the wire, and applies them to a provided object using the function.

Type Parameters:

O - The type of the object to apply the List to.

T - The type of the ReadMarshallable objects.

Parameters:

o - The object to apply the List to.

tSupplier - A Function providing instances of type T.

Returns:

The WireIn instance for method chaining.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

collection

@NotNull
default <O,T extends ReadMarshallable> @NotNull WireIn collection(@NotNull
                                                                           O o,
                                                                           Function<O,T> tSupplier)
                                                                    throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a sequence of ReadMarshallable items into a collection, where each item is constructed using the provided Function.

Type Parameters:

O - The type of the provided object.

T - The type of the ReadMarshallable.

Parameters:

o - An object passed to the function to create instances of ReadMarshallable.

tSupplier - A function that, given the object 'o', returns an instance of ReadMarshallable.

Returns:

The current WireIn instance for chaining.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If there's a serialization issue.

marshallableAsMap

@Nullable
default <K,V> @Nullable Map<K,V> marshallableAsMap(Class<K> kClass,
                                                             @NotNull
                                                             @NotNull Class<V> vClass)
                                                      throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a Map of marshallable key-value pairs as specified by the provided classes.

Type Parameters:

K - The type of keys in the Map.

V - The type of values in the Map.

Parameters:

kClass - The class of the keys.

vClass - The class of the values.

Returns:

A Map containing the key-value pairs, or null if the Map could not be read.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if the key or value types are invalid

marshallableAsMap

@Nullable
default <K,V> @Nullable Map<K,V> marshallableAsMap(Class<K> kClass,
                                                             @NotNull
                                                             @NotNull Class<V> vClass,
                                                             @NotNull
                                                             @NotNull Map<K,V> map)

Reads a Map of marshallable key-value pairs into the provided Map.

Type Parameters:

K - The type of keys in the Map.

V - The type of values in the Map.

Parameters:

kClass - The class of the keys.

vClass - The class of the values.

map - The Map to populate with the read key-value pairs.

Returns:

The provided Map populated with key-value pairs, or null if the Map could not be read.

applyToMarshallable

@Nullable
<T> T applyToMarshallable(Function<WireIn,T> marshallableReader)

Applies a Function to this ValueIn, interpreting it as a WireIn for a marshallable object.

Type Parameters:

T - The type of the result from the Function.

Parameters:

marshallableReader - The Function to apply to this ValueIn.

Returns:

The result of applying the Function to this ValueIn, or null if it cannot be applied.

typedMarshallable

@Nullable
<T> T typedMarshallable()
                           throws net.openhft.chronicle.core.io.IORuntimeException,
                                  net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a typed marshallable object from the wire.

Returns:

The marshallable object read from the wire, or null if it cannot be read.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if an I/O error occurs

net.openhft.chronicle.core.io.InvalidMarshallableException - if the marshallable object is invalid

typedMarshallable

@Nullable
default <T> T typedMarshallable(@NotNull
                                          @NotNull Function<Class<T>,ReadMarshallable> marshallableFunction)
                                   throws net.openhft.chronicle.core.io.IORuntimeException,
                                          net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a typed marshallable object from the wire, using the provided function to create instances.

Parameters:

marshallableFunction - The function to create marshallable object instances.

Returns:

The marshallable object read from the wire, or null if it cannot be read.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if an I/O error occurs

net.openhft.chronicle.core.io.InvalidMarshallableException - if the marshallable object is invalid

typePrefix

@NotNull
<T> @NotNull ValueIn typePrefix(T t,
                                         @NotNull
                                         @NotNull BiConsumer<T,CharSequence> ts)

Reads a type prefix and applies it to a given object using the provided BiConsumer.

Type Parameters:

T - The type of the object to apply the type prefix to.

Parameters:

t - The object to apply the type prefix to.

ts - The BiConsumer that accepts the object and the type prefix.

Returns:

The WireIn instance for method chaining.

typeLiteralAsText

@NotNull
<T> @NotNull WireIn typeLiteralAsText(T t,
                                               @NotNull
                                               @NotNull BiConsumer<T,CharSequence> classNameConsumer)
                                        throws net.openhft.chronicle.core.io.IORuntimeException,
                                               BufferUnderflowException

Consumes a type literal (a class name) as text from the wire, passing it to a consumer.

Type Parameters:

T - The type of the provided object.

Parameters:

t - The object to which the type literal relates.

classNameConsumer - A consumer that accepts the provided object and the read class name.

Returns:

The current WireIn instance for chaining.

Throws:

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

BufferUnderflowException - If there's not enough data in the buffer.

classLookup

net.openhft.chronicle.core.pool.ClassLookup classLookup()

Retrieves a ClassLookup instance associated with the current WireIn. The ClassLookup allows for the resolution of class names to actual Class objects.

Returns:

The associated ClassLookup instance.

typeLiteral

@NotNull
default <T> @NotNull WireIn typeLiteral(T t,
                                                 @NotNull
                                                 @NotNull BiConsumer<T,Class> classConsumer)
                                          throws net.openhft.chronicle.core.io.IORuntimeException

Reads a type literal as text and applies it to a given object using the provided BiConsumer.

Type Parameters:

T - The type of the object to apply the type literal to.

Parameters:

t - The object to apply the type literal to.

classConsumer - The BiConsumer that accepts the object and the type literal.

Returns:

The WireIn instance for method chaining.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if an I/O error occurs

BufferUnderflowException - if the buffer underflows while reading

typeLiteral

@NotNull
default <T> @NotNull WireIn typeLiteral(T t,
                                                 @NotNull
                                                 @NotNull BiConsumer<T,Class> classConsumer,
                                                 Class<?> defaultClass)

Reads a type literal from the wire, applies it to a given object using the provided BiConsumer, and uses a default Class if necessary.

Type Parameters:

T - The type of the object to apply the type literal to.

Parameters:

t - The object to apply the type literal to.

classConsumer - The BiConsumer that accepts the object and the Class derived from the type literal.

defaultClass - The default Class to use if the type literal cannot be resolved.

Returns:

The WireIn instance for method chaining.

marshallable

@Nullable
@Nullable Object marshallable(@NotNull
                                        @NotNull Object object,
                                        @NotNull
                                        @NotNull SerializationStrategy strategy)
                                 throws BufferUnderflowException,
                                        net.openhft.chronicle.core.io.IORuntimeException,
                                        net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a marshallable object from the wire and applies a specified SerializationStrategy.

Parameters:

object - The object to populate with the marshallable data.

strategy - The SerializationStrategy to use for reading the marshallable data.

Returns:

The object populated with marshallable data, or null if it cannot be read.

Throws:

BufferUnderflowException - if the buffer underflows while reading

net.openhft.chronicle.core.io.IORuntimeException - if an I/O error occurs

net.openhft.chronicle.core.io.InvalidMarshallableException - if the marshallable object is invalid

marshallable

default boolean marshallable(@NotNull
                             @NotNull Serializable object)
                      throws BufferUnderflowException,
                             net.openhft.chronicle.core.io.IORuntimeException,
                             net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a Serializable object from the wire.

Parameters:

object - The Serializable object to populate with the data.

Returns:

True if the object was successfully read, false otherwise.

Throws:

BufferUnderflowException - if the buffer underflows while reading

net.openhft.chronicle.core.io.IORuntimeException - if an I/O error occurs

net.openhft.chronicle.core.io.InvalidMarshallableException - if the Serializable object is invalid

marshallable

default boolean marshallable(@NotNull
                             @NotNull ReadMarshallable object)
                      throws BufferUnderflowException,
                             net.openhft.chronicle.core.io.IORuntimeException,
                             net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a ReadMarshallable object from the wire.

Parameters:

object - The ReadMarshallable object to populate with the data.

Returns:

True if the object was successfully read, false otherwise.

Throws:

BufferUnderflowException - if the buffer underflows while reading

net.openhft.chronicle.core.io.IORuntimeException - if an I/O error occurs

net.openhft.chronicle.core.io.InvalidMarshallableException - if the ReadMarshallable object is invalid

bool

boolean bool()

Reads a boolean value from the wire.

Returns:

The boolean value read from the wire.

int8

byte int8()

Reads an 8-bit integer (byte) value from the wire.

Returns:

The 8-bit integer value read from the wire.

int16

short int16()

Reads a 16-bit integer (short) value from the wire.

Returns:

The 16-bit integer value read from the wire.

uint16

int uint16()

Reads an unsigned 16-bit integer (represented as an int) from the wire.

Returns:

The unsigned 16-bit integer value read from the wire.

int32

int int32()

Reads a 32-bit integer (int) value from the wire.

Returns:

The 32-bit integer value read from the wire.

int32

default int int32(int previous)

Reads a 32-bit integer (int) value from the wire with a previous value as a reference.

Parameters:

previous - The previous 32-bit integer value.

Returns:

The 32-bit integer value read from the wire.

int64

long int64()

Reads a 64-bit integer (long) value from the wire.

Returns:

The 64-bit integer value read from the wire.

int64

default long int64(long previous)

Reads a 64-bit integer (long) value from the wire with a previous value as a reference.

Parameters:

previous - The previous 64-bit integer value.

Returns:

The 64-bit integer value read from the wire.

float32

float float32()

Reads a 32-bit floating point number from the wire.

Returns:

The float value read from the wire.

float32

default float float32(float previous)

Reads a 32-bit floating-point (float) value from the wire with a previous value as a reference.

Parameters:

previous - The previous 32-bit floating-point value.

Returns:

The 32-bit floating-point value read from the wire.

float64

double float64()

Reads a 64-bit floating point number from the wire. If the data is not parsed successfully, returns -0.0.

Returns:

The double value read from the wire, or -0.0 if parsing fails.

float64

default double float64(double previous)

Reads a 64-bit floating-point (double) value from the wire with a previous value as a reference.

Parameters:

previous - The previous 64-bit floating-point value.

Returns:

The 64-bit floating-point value read from the wire.

typeLiteral

@Nullable
default <T> @Nullable Class<T> typeLiteral()
                                              throws net.openhft.chronicle.core.io.IORuntimeException,
                                                     BufferUnderflowException

Reads a Class type literal from the wire.

Returns:

The Class corresponding to the type literal read from the wire, or null if it cannot be resolved.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if an I/O error occurs

BufferUnderflowException - if the buffer underflows while reading

lenientTypeLiteral

@Nullable
default @Nullable Type lenientTypeLiteral()
                                             throws net.openhft.chronicle.core.io.IORuntimeException,
                                                    BufferUnderflowException

Reads a type literal from the wire, returning it as a Type object, with a fallback for unresolved types.

Returns:

The Type corresponding to the literal read from the wire, or a fallback unresolved type.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if an I/O error occurs

BufferUnderflowException - if the buffer underflows while reading

typeLiteral

Type typeLiteral(BiFunction<CharSequence,ClassNotFoundException,Type> unresolvedHandler)

Reads a type literal from the wire, applying a handler for unresolved types.

Parameters:

unresolvedHandler - The handler to apply for unresolved types.

Returns:

The Type corresponding to the literal read from the wire, or the result of the unresolved handler.

throwable

default Throwable throwable(boolean appendCurrentStack)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a Throwable from the wire, optionally appending the current stack trace.

Parameters:

appendCurrentStack - True to append the current stack trace to the Throwable.

Returns:

The Throwable read from the wire.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if the Throwable object is invalid

asEnum

@Nullable
default <E extends Enum<E>> E asEnum(Class<E> eClass)

Reads an Enum value of the specified type from the wire.

Parameters:

eClass - The class of the Enum type.

Returns:

The Enum value read from the wire, or null if it cannot be read.

asEnum

@NotNull
default <E extends Enum<E>> @NotNull WireIn asEnum(Class<E> eClass,
                                                            @NotNull
                                                            @NotNull Consumer<E> eConsumer)

Reads an Enum value of the specified type from the wire and applies it to a Consumer.

Parameters:

eClass - The class of the Enum type.

eConsumer - The Consumer to apply the Enum value to.

Returns:

The WireIn instance for method chaining.

asEnum

@NotNull
default <E extends Enum<E>,T> @NotNull WireIn asEnum(Class<E> eClass,
                                                              T t,
                                                              @NotNull
                                                              @NotNull BiConsumer<T,E> teConsumer)

Reads an Enum value of the specified type from the wire and applies it to a given object using a BiConsumer.

Parameters:

eClass - The class of the Enum type.

t - The object to apply the Enum value to.

teConsumer - The BiConsumer that accepts the object and the Enum value.

Returns:

The WireIn instance for method chaining.

object

@Nullable
default <E> E object(@Nullable
                               @Nullable Class<E> clazz)
                        throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads an object of the specified class from the wire.

Parameters:

clazz - The class of the object to read.

Returns:

The object read from the wire, or null if it cannot be read.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if the object is invalid

object

@Nullable
default @Nullable Object object()
                                   throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

objectBestEffort

default Object objectBestEffort()

Deserializes an object from the current data stream, attempting to return any object that can be parsed.

This method is used for logging purposes and aims to be lenient, capturing and returning exceptions as results if they occur during the deserialization process.

Returns:

The deserialized object, or a Throwable if an error occurs during deserialization.

object

@Nullable
default <E> E object(@Nullable
                               E using,
                               @Nullable
                               @Nullable Class<? extends E> clazz)
                        throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads an object from the wire.

Type Parameters:

E - The type of the object to read.

Parameters:

using - An instance of the object to reuse, or null to create a new instance.

clazz - The class of the object to read.

Returns:

The object read from the wire, or null if it cannot be read.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if the object is invalid

object

default <E> E object(@Nullable
                     E using,
                     @Nullable
                     @Nullable Class<? extends E> clazz,
                     boolean bestEffort)
              throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads an object from the wire.

Type Parameters:

E - The type of the object to read.

Parameters:

using - An instance of the object to reuse, or null to create a new instance.

clazz - The class of the object to read.

bestEffort - Set to true for best effort reading, which may not throw exceptions for some errors.

Returns:

The object read from the wire, or null if it cannot be read.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if the object is invalid

getBracketType

@NotNull
@NotNull BracketType getBracketType()

Gets the bracket type for the current value in the wire.

Returns:

The BracketType of the current value.

isNull

boolean isNull()

Checks if the current value in the wire is null.

Returns:

True if the current value is null, false otherwise.

object

@Nullable
default <T,E> @Nullable WireIn object(@NotNull
                                                @NotNull Class<E> clazz,
                                                T t,
                                                @NotNull
                                                @NotNull BiConsumer<T,E> e)
                                         throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads an object of a specified class from the wire and applies it to a given object using a BiConsumer.

Type Parameters:

T - The type of the object to apply the read value to.

E - The type of the object being read.

Parameters:

clazz - The class of the object being read.

t - The object to apply the read value to.

e - The BiConsumer that accepts the object and the read value.

Returns:

The WireIn instance for method chaining.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if the object is invalid

isTyped

boolean isTyped()

Checks if the current value in the wire is typed.

Returns:

True if the current value is typed, false otherwise.

typePrefix

@Nullable
@Nullable Class<?> typePrefix()

Reads the type prefix from the wire.

Returns:

The type prefix as a Class, or null if it cannot be read.

typePrefixOrObject

@Nullable
default @Nullable Object typePrefixOrObject(Class<?> tClass)
                                               throws net.openhft.chronicle.core.util.ClassNotFoundRuntimeException

read a class with a super class or actual class as a hint

Parameters:

tClass - the super-class, or actual class to use

Returns:

the class or an instance of an object to use.

Throws:

net.openhft.chronicle.core.util.ClassNotFoundRuntimeException - if the specific class couldn't be found.

resetState

void resetState()

Resets the internal state of this ValueIn.

objectWithInferredType

@Nullable
@Nullable Object objectWithInferredType(Object using,
                                                  SerializationStrategy strategy,
                                                  Class<?> type)
                                           throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads an object from the wire with an inferred type.

Parameters:

using - An instance of the object to reuse, or null to create a new instance.

strategy - The SerializationStrategy to use for reading the object.

type - The type of the object to read.

Returns:

The object read from the wire, or null if it cannot be read.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if the object is invalid

isPresent

default boolean isPresent()

Checks if a value is present in the data stream.

Returns:

True if a value is present, false otherwise.

uuid

@NotNull
default @NotNull UUID uuid()

Reads a UUID from the wire.

Returns:

The UUID read from the wire, or null if it cannot be read.

isBinary

default boolean isBinary()

Checks if the current value in the wire is binary.

Returns:

True if the current value is binary, false otherwise.

readLong

default long readLong(LongConverter longConverter)

Reads a long value from the wire using a LongConverter.

Parameters:

longConverter - The LongConverter to use for reading the long value.

Returns:

The long value read from the wire.

readBoolean

default boolean readBoolean()

Reads a boolean value from the wire.

Returns:

The boolean value read from the wire.

readByte

default byte readByte()

Reads a byte value from the wire.

Returns:

The byte value read from the wire.

readChar

default char readChar()

Reads a char value from the wire.

Returns:

The char value read from the wire.

readShort

default short readShort()

Reads a short value from the wire.

Returns:

The short value read from the wire.

readInt

default int readInt()

Reads an int value from the wire.

Returns:

The int value read from the wire.

readLong

default long readLong()

Reads a long value from the wire.

Returns:

The long value read from the wire.

readFloat

default float readFloat()

Reads a float value from the wire.

Returns:

The float value read from the wire.

readDouble

default double readDouble()

Reads a double value from the wire.

Returns:

The double value read from the wire.

readString

default String readString()

Reads a String from the wire.

Returns:

The String read from the wire, or null if it cannot be read.