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

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

Field Detail

SMALL_MESSAGE

static final int SMALL_MESSAGE

See Also:

Constant Field Values

Method Detail

bool

@NotNull
WireOut bool(Boolean flag)

scalar data types

text

@NotNull
WireOut text(@Nullable
                      CharSequence s)

text

@NotNull
default WireOut text(@Nullable
                              String s)

nu11

@NotNull
default WireOut nu11()

text

@NotNull
default WireOut text(char c)

character

@NotNull
default WireOut character(char c)

text

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

int8

@NotNull
default WireOut int8(long x)

int8

@NotNull
WireOut int8(byte i8)

bytes

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

bytesLiteral

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

bytes

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

rawBytes

@NotNull
WireOut rawBytes(byte[] value)

writeLength

@NotNull
ValueOut writeLength(long remaining)

bytes

@NotNull
WireOut bytes(byte[] fromBytes)

bytes

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

uint8

@NotNull
default WireOut uint8(int x)

uint8checked

@NotNull
WireOut uint8checked(int u8)

int16

@NotNull
default WireOut int16(long x)

int16

@NotNull
WireOut int16(short i16)

uint16

@NotNull
default WireOut uint16(long x)

uint16checked

@NotNull
WireOut uint16checked(int u16)

utf8

@NotNull
WireOut utf8(int codepoint)

int32

@NotNull
default WireOut int32(long x)

int32

@NotNull
WireOut int32(int i32)

int32

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

uint32

@NotNull
default WireOut uint32(long x)

uint32checked

@NotNull
WireOut uint32checked(long u32)

int64

@NotNull
WireOut int64(long i64)

int64

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

int128forBinding

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

int64_0x

@NotNull
WireOut int64_0x(long i64)

int64array

@NotNull
WireOut int64array(long capacity)

int64array

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

float32

@NotNull
WireOut float32(float f)

float64

@NotNull
WireOut float64(double d)

float32

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

float64

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

time

@NotNull
WireOut time(LocalTime localTime)

zonedDateTime

@NotNull
WireOut zonedDateTime(ZonedDateTime zonedDateTime)

date

@NotNull
WireOut date(LocalDate localDate)

dateTime

@NotNull
WireOut dateTime(LocalDateTime localDateTime)

typePrefix

@NotNull
ValueOut typePrefix(CharSequence typeName)

typePrefix

@NotNull
default ValueOut typePrefix(Class type)

typeLiteral

@NotNull
default WireOut typeLiteral(@Nullable
                                     Class type)

typeLiteral

@NotNull
WireOut typeLiteral(@Nullable
                             CharSequence type)

typeLiteral

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

uuid

@NotNull
WireOut uuid(UUID uuid)

int32forBinding

@NotNull
WireOut int32forBinding(int value)

int32forBinding

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

int64forBinding

@NotNull
WireOut int64forBinding(long value)

int128forBinding

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

int64forBinding

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

boolForBinding

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

sequence

@NotNull
default WireOut sequence(WriteValue writer)

sequence

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

sequence

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

sequence

@NotNull
<T,K> 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 WireOut array(@NotNull
                               WriteValue writer,
                               @NotNull
                               Class arrayType)

marshallable

@NotNull
WireOut marshallable(WriteMarshallable object)

marshallable

@NotNull
WireOut marshallable(Serializable object)

map

@NotNull
 @Deprecated
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
WireOut typedMap(@NotNull
                                       Map<? extends WriteMarshallable,? extends Marshallable> map)

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

leaf

@NotNull
 @Deprecated
default ValueOut leaf()

Deprecated.

leaf

@NotNull
 @Deprecated
default ValueOut leaf(boolean leaf)

Deprecated.

swapLeaf

@NotNull
default boolean swapLeaf(boolean isLeaf)

typedMarshallable

@NotNull
default WireOut typedMarshallable(@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 WireOut typedMarshallable(@Nullable
                                           Serializable object)

typedMarshallable

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

asEnum

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

set

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

set

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

list

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

list

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

collection

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

object

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

marshallable

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

marshallable

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

object

@NotNull
default WireOut object(@Nullable
                                Object value)

optionalTyped

@NotNull
default ValueOut optionalTyped(Class aClass)

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

Parameters:

aClass - to write

Returns:

this

fixedFloat32

@NotNull
default WireOut fixedFloat32(float value)

fixedInt8

@NotNull
default WireOut fixedInt8(byte value)

fixedInt16

@NotNull
default WireOut fixedInt16(short value)

fixedInt32

@NotNull
default WireOut fixedInt32(int value)

fixedFloat64

@NotNull
default WireOut fixedFloat64(double value)

fixedInt64

@NotNull
default WireOut fixedInt64(long value)

untypedObject

@NotNull
default WireOut untypedObject(@Nullable
                                       Object value)

typedScalar

@NotNull
default WireOut typedScalar(@NotNull
                                     Object value)

throwable

@NotNull
default WireOut throwable(@NotNull
                                   Throwable t)

wireOut

@NotNull
WireOut wireOut()

compress

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

compressedSize

default int compressedSize()

compress

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

Deprecated.

resetBetweenDocuments

default void resetBetweenDocuments()

resetState

void resetState()