net.openhft.chronicle.wire

Class BinaryWire

java.lang.Object

net.openhft.chronicle.wire.BinaryWire

All Implemented Interfaces:

Wire, WireIn, WireOut

public class BinaryWire
extends Object
implements Wire

Created by peter.lawrey on 15/01/15.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANY_CODE_MATCH

Constructor Summary

Constructors

Constructor and Description
BinaryWire(net.openhft.chronicle.bytes.Bytes<?> bytes)
BinaryWire(net.openhft.chronicle.bytes.Bytes<?> bytes, boolean fixed, boolean numericFields, boolean fieldLess)

Method Summary

Modifier and Type	Method and Description
WireOut	addPadding(int paddingToAdd)
net.openhft.chronicle.bytes.Bytes<?>	bytes()
void	clear()
void	copyTo(WireOut wire)
void	flip()
boolean	hasDocument()
boolean	hasMapping()
boolean	hasNextSequenceItem()
ValueIn	read() Read the field if present, or empty string if not present.
ValueIn	read(StringBuilder name) Read the field if present, or empty string if not present.
ValueIn	read(WireKey key) Read the field if present which must match the WireKey.
Wire	readComment(StringBuilder s)
ValueIn	readEventName(StringBuilder name) Read a field, or string which is always written, even for formats which might drop the field such as RAW.
String	toString()
ValueOut	write() Write an empty filed marker
ValueOut	write(WireKey key) Write a key for wires that support fields.
Wire	writeComment(CharSequence s)
ValueOut	writeEventName(WireKey key) Always write a key.
ValueOut	writeValue() write a field less value.

Methods inherited from class java.lang.Object

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

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

readDocument

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

writeDocument

Field Detail

ANY_CODE_MATCH

public static final int ANY_CODE_MATCH

See Also:

Constant Field Values

Constructor Detail

BinaryWire

public BinaryWire(net.openhft.chronicle.bytes.Bytes<?> bytes)

BinaryWire

public BinaryWire(net.openhft.chronicle.bytes.Bytes<?> bytes,
                  boolean fixed,
                  boolean numericFields,
                  boolean fieldLess)

Method Detail

bytes

public net.openhft.chronicle.bytes.Bytes<?> bytes()

Specified by:

bytes in interface WireIn

Specified by:

bytes in interface WireOut

copyTo

public void copyTo(WireOut wire)

Specified by:

copyTo in interface WireIn

write

public ValueOut write()

Description copied from interface: WireOut

Write an empty filed marker

Specified by:

write in interface WireOut

writeValue

public ValueOut writeValue()

Description copied from interface: WireOut

write a field less value.

Specified by:

writeValue in interface WireOut

write

public ValueOut write(WireKey key)

Description copied from interface: WireOut

Write a key for wires that support fields.

Specified by:

write in interface WireOut

writeEventName

public ValueOut writeEventName(WireKey key)

Description copied from interface: WireOut

Always write a key. For RAW types, this label with be in text. To read this, use readEventName()

Specified by:

writeEventName in interface WireOut

read

public ValueIn read()

Description copied from interface: WireIn

Read the field if present, or empty string if not present.

Specified by:

read in interface WireIn

read

public ValueIn read(WireKey key)

Description copied from interface: WireIn

Read the field if present which must match the WireKey.

Specified by:

read in interface WireIn

read

public ValueIn read(StringBuilder name)

Description copied from interface: WireIn

Read the field if present, or empty string if not present.

Specified by:

read in interface WireIn

readEventName

public ValueIn readEventName(StringBuilder name)

Description copied from interface: WireIn

Read a field, or string which is always written, even for formats which might drop the field such as RAW.

Specified by:

readEventName in interface WireIn

hasNextSequenceItem

public boolean hasNextSequenceItem()

Specified by:

hasNextSequenceItem in interface WireIn

hasMapping

public boolean hasMapping()

Specified by:

hasMapping in interface WireIn

Specified by:

hasMapping in interface WireOut

hasDocument

public boolean hasDocument()

Specified by:

hasDocument in interface WireOut

flip

public void flip()

Specified by:

flip in interface WireIn

clear

public void clear()

Specified by:

clear in interface WireIn

toString

public String toString()

Overrides:

toString in class Object

writeComment

public Wire writeComment(CharSequence s)

Specified by:

writeComment in interface WireOut

readComment

public Wire readComment(StringBuilder s)

Specified by:

readComment in interface WireIn

addPadding

public WireOut addPadding(int paddingToAdd)

Specified by:

addPadding in interface WireOut