net.openhft.chronicle.wire

Interface ValueOut

All Known Implementing Classes:

BinaryWire.BinaryValueOut, BinaryWire.FixedBinaryValueOut

public interface ValueOut

Write out data after writing a field.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SMALL_MESSAGE
static String	ZEROS_64

Method Summary

Modifier and Type	Method and Description
default WireOut	array(boolean[] array, int length)
default WireOut	array(byte[] array, int length)
default WireOut	array(net.openhft.chronicle.bytes.Bytes[] array, int length)
default WireOut	array(double[] array, int length)
default WireOut	array(int[] array, int length)
default WireOut	array(long[] array, int length)
default @NotNull WireOut	array(@NotNull WriteValue writer, @NotNull Class arrayType)
default WireOut	arrayDelta(double[] array, int length) This write values relative to the first one using 6 digit precision
default WireOut	arrayDelta(long[] array, int length)
default <E extends Enum<E>> @NotNull WireOut	asEnum(E e)
@NotNull WireOut	bool(Boolean flag) scalar data types
@NotNull WireOut	boolForBinding(boolean value, @NotNull net.openhft.chronicle.core.values.BooleanValue longValue)
@NotNull WireOut	bytes(byte[] fromBytes)
@NotNull WireOut	bytes(@Nullable net.openhft.chronicle.bytes.BytesStore fromBytes)
@NotNull WireOut	bytes(String type, byte[] fromBytes)
@NotNull WireOut	bytes(String type, @Nullable net.openhft.chronicle.bytes.BytesStore fromBytes)
default @NotNull WireOut	bytesLiteral(@Nullable net.openhft.chronicle.bytes.BytesStore fromBytes)
default WireOut	bytesMarshallable(net.openhft.chronicle.bytes.WriteBytesMarshallable value)
default @NotNull WireOut	character(char c)
default <V> @NotNull WireOut	collection(Collection<V> coll, Class<V> assumedClass)
default @NotNull WireOut	compress(@NotNull String compression, @Nullable net.openhft.chronicle.bytes.Bytes uncompressedBytes)
default @NotNull WireOut	compress(@NotNull String compression, @Nullable String str) Deprecated.
default int	compressedSize()
@NotNull WireOut	date(LocalDate localDate)
@NotNull WireOut	dateTime(LocalDateTime localDateTime)
default @NotNull WireOut	fixedFloat32(float value)
default @NotNull WireOut	fixedFloat64(double value)
default @NotNull WireOut	fixedInt16(short value)
default @NotNull WireOut	fixedInt32(int value)
default @NotNull WireOut	fixedInt64(long value)
default @NotNull WireOut	fixedInt8(byte value)
@NotNull WireOut	float32(float f)
default @NotNull WireOut	float32(float f, float previous)
@NotNull WireOut	float64(double d)
default @NotNull WireOut	float64(double d, double previous)
default @NotNull WireOut	int128forBinding(long value, long value2)
@NotNull WireOut	int128forBinding(long i64x0, long i64x1, net.openhft.chronicle.core.values.TwoLongValue value)
default @NotNull WireOut	int16(long x)
@NotNull WireOut	int16(short i16)
@NotNull WireOut	int32(int i32)
default @NotNull WireOut	int32(int i32, int previous)
default @NotNull WireOut	int32(long x)
@NotNull WireOut	int32forBinding(int value)
@NotNull WireOut	int32forBinding(int value, @NotNull net.openhft.chronicle.core.values.IntValue intValue)
@NotNull WireOut	int64_0x(long i64)
@NotNull WireOut	int64(long i64)
default @NotNull WireOut	int64(long i64, long previous)
@NotNull WireOut	int64array(long capacity)
@NotNull WireOut	int64array(long capacity, net.openhft.chronicle.core.values.LongArrayValues values)
@NotNull WireOut	int64forBinding(long value)
@NotNull WireOut	int64forBinding(long value, @NotNull net.openhft.chronicle.core.values.LongValue longValue)
@NotNull WireOut	int8(byte i8)
default @NotNull WireOut	int8(long x)
static <V> boolean	isAnEnum(V v)
default boolean	isBinary()
default @NotNull ValueOut	leaf() Deprecated.
default @NotNull ValueOut	leaf(boolean leaf) Deprecated.
default <V> @NotNull WireOut	list(List<V> coll)
default <V> @NotNull WireOut	list(List<V> coll, Class<V> assumedClass)
@NotNull WireOut	map(Map map) Deprecated. use marshallable(map) or object(map)
default <K,V> @NotNull WireOut	marshallable(Map<K,V> map)
default <K,V> @NotNull WireOut	marshallable(@Nullable Map<K,V> map, @NotNull Class<K> kClass, @NotNull Class<V> vClass, boolean leaf)
@NotNull WireOut	marshallable(Serializable object)
@NotNull WireOut	marshallable(WriteMarshallable object)
default @NotNull WireOut	nu11()
default <V> @NotNull WireOut	object(@NotNull Class<V> expectedType, V v)
default @NotNull WireOut	object(@Nullable Object value)
default @NotNull ValueOut	optionalTyped(Class aClass) Add an optional type i.e.
@NotNull WireOut	rawBytes(byte[] value)
default @NotNull WireOut	rawText(CharSequence value)
default void	resetBetweenDocuments()
void	resetState()
default <T> @NotNull WireOut	sequence(Iterable<T> t)
<T> @NotNull WireOut	sequence(T t, BiConsumer<T,ValueOut> writer)
<T,K> @NotNull WireOut	sequence(T t, K kls, TriConsumer<T,K,ValueOut> writer)
default @NotNull WireOut	sequence(WriteValue writer)
default <T,K> WireOut	sequenceWithLength(T t, int length, ObjectIntObjectConsumer<T,ValueOut> writer)
default <V> @NotNull WireOut	set(Set<V> coll)
default <V> @NotNull WireOut	set(Set<V> coll, Class<V> assumedClass)
default boolean	swapLeaf(boolean isLeaf)
default @NotNull WireOut	text(@Nullable net.openhft.chronicle.bytes.BytesStore s)
default @NotNull WireOut	text(char c)
@NotNull WireOut	text(@Nullable CharSequence s)
default @NotNull WireOut	text(@Nullable String s)
default @NotNull WireOut	throwable(@NotNull Throwable t)
@NotNull WireOut	time(LocalTime localTime)
@NotNull WireOut	typedMap(@NotNull Map<? extends WriteMarshallable,? extends Marshallable> map) Deprecated. use typedMarshallable(map) or object(map)
default @NotNull WireOut	typedMarshallable(CharSequence typeName, WriteMarshallable object)
default @NotNull WireOut	typedMarshallable(@Nullable Serializable object)
default @NotNull WireOut	typedMarshallable(@Nullable WriteMarshallable marshallable) To be used when you know it is a typed marshallable object.
default @NotNull WireOut	typedScalar(@NotNull Object value)
@NotNull WireOut	typeLiteral(@NotNull BiConsumer<Class,net.openhft.chronicle.bytes.Bytes> typeTranslator, @Nullable Class type)
@NotNull WireOut	typeLiteral(@Nullable CharSequence type)
default @NotNull WireOut	typeLiteral(@Nullable Class type)
default @NotNull WireOut	typeLiteral(@Nullable Type type)
@NotNull ValueOut	typePrefix(CharSequence typeName)
default @NotNull ValueOut	typePrefix(Class type)
default @NotNull WireOut	uint16(long x)
@NotNull WireOut	uint16checked(int u16)
default @NotNull WireOut	uint32(long x)
@NotNull WireOut	uint32checked(long u32)
default @NotNull WireOut	uint8(int x)
@NotNull WireOut	uint8checked(int u8)
default @NotNull WireOut	untypedObject(@Nullable Object value)
@NotNull WireOut	utf8(int codepoint)
@NotNull WireOut	uuid(UUID uuid)
@NotNull WireOut	wireOut()
default WireOut	writeBoolean(boolean x)
default WireOut	writeByte(byte x)
default WireOut	writeChar(char x)
default WireOut	writeDouble(double x)
default WireOut	writeFloat(float x)
default WireOut	writeInt(int x)
@NotNull ValueOut	writeLength(long remaining)
default WireOut	writeLong(long x)
default WireOut	writeLong(LongConverter longConverter, long l)
default WireOut	writeShort(short x)
default WireOut	writeString(CharSequence x)
@NotNull WireOut	zonedDateTime(ZonedDateTime zonedDateTime)

Field Detail

SMALL_MESSAGE

static final int SMALL_MESSAGE

See Also:

Constant Field Values

ZEROS_64

static final String ZEROS_64

See Also:

Constant Field Values

Method Detail

isAnEnum

static <V> boolean isAnEnum(V v)

bool

@NotNull
@NotNull WireOut bool(Boolean flag)

scalar data types

text

@NotNull
@NotNull WireOut text(@Nullable
                               @Nullable CharSequence s)

text

@NotNull
default @NotNull WireOut text(@Nullable
                                       @Nullable String s)

nu11

@NotNull
default @NotNull WireOut nu11()

text

@NotNull
default @NotNull WireOut text(char c)

character

@NotNull
default @NotNull WireOut character(char c)

text

@NotNull
default @NotNull WireOut text(@Nullable
                                       @Nullable net.openhft.chronicle.bytes.BytesStore s)

int8

@NotNull
default @NotNull WireOut int8(long x)

int8

@NotNull
@NotNull WireOut int8(byte i8)

bytes

@NotNull
@NotNull WireOut bytes(@Nullable
                                @Nullable net.openhft.chronicle.bytes.BytesStore fromBytes)

bytesLiteral

@NotNull
default @NotNull WireOut bytesLiteral(@Nullable
                                               @Nullable net.openhft.chronicle.bytes.BytesStore fromBytes)

bytes

@NotNull
@NotNull WireOut bytes(String type,
                                @Nullable
                                @Nullable net.openhft.chronicle.bytes.BytesStore fromBytes)

rawBytes

@NotNull
@NotNull WireOut rawBytes(byte[] value)

rawText

@NotNull
default @NotNull WireOut rawText(CharSequence value)

writeLength

@NotNull
@NotNull ValueOut writeLength(long remaining)

bytes

@NotNull
@NotNull WireOut bytes(byte[] fromBytes)

bytes

@NotNull
@NotNull WireOut bytes(String type,
                                byte[] fromBytes)

uint8

@NotNull
default @NotNull WireOut uint8(int x)

uint8checked

@NotNull
@NotNull WireOut uint8checked(int u8)

int16

@NotNull
default @NotNull WireOut int16(long x)

int16

@NotNull
@NotNull WireOut int16(short i16)

uint16

@NotNull
default @NotNull WireOut uint16(long x)

uint16checked

@NotNull
@NotNull WireOut uint16checked(int u16)

utf8

@NotNull
@NotNull WireOut utf8(int codepoint)

int32

@NotNull
default @NotNull WireOut int32(long x)

int32

@NotNull
@NotNull WireOut int32(int i32)

int32

@NotNull
default @NotNull WireOut int32(int i32,
                                        int previous)

uint32

@NotNull
default @NotNull WireOut uint32(long x)

uint32checked

@NotNull
@NotNull WireOut uint32checked(long u32)

int64

@NotNull
@NotNull WireOut int64(long i64)

int64

@NotNull
default @NotNull WireOut int64(long i64,
                                        long previous)

int128forBinding

@NotNull
@NotNull WireOut int128forBinding(long i64x0,
                                           long i64x1,
                                           net.openhft.chronicle.core.values.TwoLongValue value)

int64_0x

@NotNull
@NotNull WireOut int64_0x(long i64)

int64array

@NotNull
@NotNull WireOut int64array(long capacity)

int64array

@NotNull
@NotNull WireOut int64array(long capacity,
                                     net.openhft.chronicle.core.values.LongArrayValues values)

float32

@NotNull
@NotNull WireOut float32(float f)

float64

@NotNull
@NotNull WireOut float64(double d)

float32

@NotNull
default @NotNull WireOut float32(float f,
                                          float previous)

float64

@NotNull
default @NotNull WireOut float64(double d,
                                          double previous)

time

@NotNull
@NotNull WireOut time(LocalTime localTime)

zonedDateTime

@NotNull
@NotNull WireOut zonedDateTime(ZonedDateTime zonedDateTime)

date

@NotNull
@NotNull WireOut date(LocalDate localDate)

dateTime

@NotNull
@NotNull WireOut dateTime(LocalDateTime localDateTime)

typePrefix

@NotNull
@NotNull ValueOut typePrefix(CharSequence typeName)

typePrefix

@NotNull
default @NotNull ValueOut typePrefix(Class type)

typeLiteral

@NotNull
default @NotNull WireOut typeLiteral(@Nullable
                                              @Nullable Class type)

typeLiteral

@NotNull
default @NotNull WireOut typeLiteral(@Nullable
                                              @Nullable Type type)

typeLiteral

@NotNull
@NotNull WireOut typeLiteral(@Nullable
                                      @Nullable CharSequence type)

typeLiteral

@NotNull
@NotNull WireOut typeLiteral(@NotNull
                                      @NotNull BiConsumer<Class,net.openhft.chronicle.bytes.Bytes> typeTranslator,
                                      @Nullable
                                      @Nullable Class type)

uuid

@NotNull
@NotNull WireOut uuid(UUID uuid)

int32forBinding

@NotNull
@NotNull WireOut int32forBinding(int value)

int32forBinding

@NotNull
@NotNull WireOut int32forBinding(int value,
                                          @NotNull
                                          @NotNull net.openhft.chronicle.core.values.IntValue intValue)

int64forBinding

@NotNull
@NotNull WireOut int64forBinding(long value)

int128forBinding

@NotNull
default @NotNull WireOut int128forBinding(long value,
                                                   long value2)

int64forBinding

@NotNull
@NotNull WireOut int64forBinding(long value,
                                          @NotNull
                                          @NotNull net.openhft.chronicle.core.values.LongValue longValue)

boolForBinding

@NotNull
@NotNull WireOut boolForBinding(boolean value,
                                         @NotNull
                                         @NotNull net.openhft.chronicle.core.values.BooleanValue longValue)

sequence

@NotNull
default @NotNull WireOut sequence(WriteValue writer)

sequence

@NotNull
default <T> @NotNull WireOut sequence(Iterable<T> t)

sequence

@NotNull
<T> @NotNull WireOut sequence(T t,
                                       BiConsumer<T,ValueOut> writer)

sequence

@NotNull
<T,K> @NotNull WireOut sequence(T t,
                                         K kls,
                                         TriConsumer<T,K,ValueOut> writer)

sequenceWithLength

default <T,K> WireOut sequenceWithLength(T t,
                                         int length,
                                         ObjectIntObjectConsumer<T,ValueOut> writer)

array

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

array

default WireOut array(double[] array,
                      int length)

arrayDelta

default WireOut arrayDelta(double[] array,
                           int length)

This write values relative to the first one using 6 digit precision

Parameters:

array - to write

length - to write

Returns:

this

array

default WireOut array(boolean[] array,
                      int length)

array

default WireOut array(long[] array,
                      int length)

arrayDelta

default WireOut arrayDelta(long[] array,
                           int length)

array

default WireOut array(int[] array,
                      int length)

array

default WireOut array(byte[] array,
                      int length)

array

@NotNull
default @NotNull WireOut array(@NotNull
                                        @NotNull WriteValue writer,
                                        @NotNull
                                        @NotNull Class arrayType)

marshallable

@NotNull
@NotNull WireOut marshallable(WriteMarshallable object)

marshallable

@NotNull
@NotNull WireOut marshallable(Serializable object)

map

@NotNull
 @Deprecated
@NotNull WireOut map(Map map)

Deprecated. use marshallable(map) or object(map)

writes the contents of the map to wire

Parameters:

map - a java map with, the key and value type of the map must be either Marshallable, String or Autoboxed primitives.

Returns:

throws IllegalArgumentException If the type of the map is not one of those listed above

typedMap

@NotNull
 @Deprecated
@NotNull WireOut typedMap(@NotNull
                                                @NotNull Map<? extends WriteMarshallable,? extends Marshallable> map)

Deprecated. use typedMarshallable(map) or object(map)

leaf

@NotNull
 @Deprecated
default @NotNull ValueOut leaf()

Deprecated.

leaf

@NotNull
 @Deprecated
default @NotNull ValueOut leaf(boolean leaf)

Deprecated.

swapLeaf

default boolean swapLeaf(boolean isLeaf)

typedMarshallable

@NotNull
default @NotNull WireOut typedMarshallable(@Nullable
                                                    @Nullable WriteMarshallable marshallable)

To be used when you know it is a typed marshallable object. e.g. an Enum is not, it's a scalar. If you are not sure, use the object(x) method.

Parameters:

marshallable - to write

Returns:

the original wire

typedMarshallable

@NotNull
default @NotNull WireOut typedMarshallable(@Nullable
                                                    @Nullable Serializable object)

typedMarshallable

@NotNull
default @NotNull WireOut typedMarshallable(CharSequence typeName,
                                                    WriteMarshallable object)

asEnum

@NotNull
default <E extends Enum<E>> @NotNull WireOut asEnum(@Nullable
                                                             E e)

set

@NotNull
default <V> @NotNull WireOut set(Set<V> coll)

set

@NotNull
default <V> @NotNull WireOut set(Set<V> coll,
                                          Class<V> assumedClass)

list

@NotNull
default <V> @NotNull WireOut list(List<V> coll)

list

@NotNull
default <V> @NotNull WireOut list(List<V> coll,
                                           Class<V> assumedClass)

collection

@NotNull
default <V> @NotNull WireOut collection(Collection<V> coll,
                                                 Class<V> assumedClass)

object

@NotNull
default <V> @NotNull WireOut object(@NotNull
                                             @NotNull Class<V> expectedType,
                                             V v)

marshallable

@NotNull
default <K,V> @NotNull WireOut marshallable(Map<K,V> map)

marshallable

@NotNull
default <K,V> @NotNull WireOut marshallable(@Nullable
                                                     @Nullable Map<K,V> map,
                                                     @NotNull
                                                     @NotNull Class<K> kClass,
                                                     @NotNull
                                                     @NotNull Class<V> vClass,
                                                     boolean leaf)

object

@NotNull
default @NotNull WireOut object(@Nullable
                                         @Nullable Object value)

bytesMarshallable

default WireOut bytesMarshallable(net.openhft.chronicle.bytes.WriteBytesMarshallable value)

optionalTyped

@NotNull
default @NotNull ValueOut optionalTyped(Class aClass)

Add an optional type i.e. if TEXT is used.

Parameters:

aClass - to write

Returns:

this

fixedFloat32

@NotNull
default @NotNull WireOut fixedFloat32(float value)

fixedInt8

@NotNull
default @NotNull WireOut fixedInt8(byte value)

fixedInt16

@NotNull
default @NotNull WireOut fixedInt16(short value)

fixedInt32

@NotNull
default @NotNull WireOut fixedInt32(int value)

fixedFloat64

@NotNull
default @NotNull WireOut fixedFloat64(double value)

fixedInt64

@NotNull
default @NotNull WireOut fixedInt64(long value)

untypedObject

@NotNull
default @NotNull WireOut untypedObject(@Nullable
                                                @Nullable Object value)

typedScalar

@NotNull
default @NotNull WireOut typedScalar(@NotNull
                                              @NotNull Object value)

throwable

@NotNull
default @NotNull WireOut throwable(@NotNull
                                            @NotNull Throwable t)

wireOut

@NotNull
@NotNull WireOut wireOut()

compress

@NotNull
default @NotNull WireOut compress(@NotNull
                                           @NotNull String compression,
                                           @Nullable
                                           @Nullable net.openhft.chronicle.bytes.Bytes uncompressedBytes)

compressedSize

default int compressedSize()

compress

@NotNull
 @Deprecated
default @NotNull WireOut compress(@NotNull
                                                        @NotNull String compression,
                                                        @Nullable
                                                        @Nullable String str)

Deprecated.

resetBetweenDocuments

default void resetBetweenDocuments()

resetState

void resetState()

isBinary

default boolean isBinary()

writeBoolean

default WireOut writeBoolean(boolean x)

writeByte

default WireOut writeByte(byte x)

writeChar

default WireOut writeChar(char x)

writeShort

default WireOut writeShort(short x)

writeInt

default WireOut writeInt(int x)

writeLong

default WireOut writeLong(long x)

writeFloat

default WireOut writeFloat(float x)

writeDouble

default WireOut writeDouble(double x)

writeString

default WireOut writeString(CharSequence x)

writeLong

default WireOut writeLong(LongConverter longConverter,
                          long l)