net.openhft.chronicle.wire

Class RawWire

java.lang.Object

net.openhft.chronicle.wire.RawWire

All Implemented Interfaces:

InternalWire, Wire, WireCommon, WireIn, WireOut

public class RawWire
extends Object
implements Wire, InternalWire

This format writes just the data, without meta data.

Constructor Summary

Constructors

Constructor and Description
RawWire(net.openhft.chronicle.bytes.Bytes bytes)
RawWire(net.openhft.chronicle.bytes.Bytes bytes, boolean use8bit)

Method Summary

Modifier and Type	Method and Description
WireOut	addPadding(int paddingToAdd)
net.openhft.chronicle.bytes.Bytes	bytes()
void	clear()
void	copyTo(WireOut wire)
ValueIn	getValueIn() Obtain the value in (for internal use)
ValueOut	getValueOut() Obtain the value out
boolean	hasMore()
boolean	isReady()
net.openhft.chronicle.core.values.IntValue	newIntReference()
net.openhft.chronicle.bytes.ref.BinaryLongArrayReference	newLongArrayReference()
net.openhft.chronicle.core.values.LongValue	newLongReference()
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.
WireIn	readAlignTo(int alignment)
Wire	readComment(StringBuilder sb)
ValueIn	readEventName(StringBuilder name) Read a field, or string which is always written, even for formats which might drop the field such as RAW.
DocumentContext	readingDocument()
DocumentContext	readingDocument(long readLocation)
void	setReady(boolean ready)
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.
DocumentContext	writingDocument(boolean metaData)

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.Wire

fromFile

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

rawReadData, readDocument, readDocument

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

writeAlignTo, writeDocument, writeNotReadyDocument

Constructor Detail

RawWire

public RawWire(net.openhft.chronicle.bytes.Bytes bytes)

RawWire

public RawWire(net.openhft.chronicle.bytes.Bytes bytes,
               boolean use8bit)

Method Detail

writingDocument

public DocumentContext writingDocument(boolean metaData)

Specified by:

writingDocument in interface WireOut

readingDocument

public DocumentContext readingDocument()

Specified by:

readingDocument in interface WireIn

readingDocument

public DocumentContext readingDocument(long readLocation)

Specified by:

readingDocument in interface WireIn

isReady

public boolean isReady()

Specified by:

isReady in interface WireIn

setReady

public void setReady(boolean ready)

Specified by:

setReady in interface InternalWire

copyTo

public void copyTo(@NotNull
                   WireOut wire)

Specified by:

copyTo in interface WireIn

read

@NotNull
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

@NotNull
public ValueIn read(@NotNull
                             WireKey key)

Description copied from interface: WireIn

Read the field if present which must match the WireKey.

Specified by:

read in interface WireIn

readEventName

@NotNull
public ValueIn readEventName(@NotNull
                                      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

read

@NotNull
public ValueIn read(@NotNull
                             StringBuilder name)

Description copied from interface: WireIn

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

Specified by:

read in interface WireIn

getValueIn

@NotNull
public ValueIn getValueIn()

Description copied from interface: WireIn

Obtain the value in (for internal use)

Specified by:

getValueIn in interface WireIn

readComment

@NotNull
public Wire readComment(@NotNull
                                 StringBuilder sb)

Specified by:

readComment in interface WireIn

clear

public void clear()

Specified by:

clear in interface WireIn

bytes

@NotNull
public net.openhft.chronicle.bytes.Bytes bytes()

Specified by:

bytes in interface WireCommon

Returns:

the underlying Bytes

hasMore

public boolean hasMore()

Specified by:

hasMore in interface WireIn

Returns:

if there is more data to be read in this document.

readAlignTo

@NotNull
public WireIn readAlignTo(int alignment)

Specified by:

readAlignTo in interface WireIn

toString

public String toString()

Overrides:

toString in class Object

write

@NotNull
public ValueOut write()

Description copied from interface: WireOut

Write an empty filed marker

Specified by:

write in interface WireOut

writeEventName

@NotNull
public ValueOut writeEventName(@NotNull
                                        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

write

@NotNull
public ValueOut write(@NotNull
                               WireKey key)

Description copied from interface: WireOut

Write a key for wires that support fields.

Specified by:

write in interface WireOut

getValueOut

@NotNull
public ValueOut getValueOut()

Description copied from interface: WireOut

Obtain the value out

Specified by:

getValueOut in interface WireOut

writeComment

@NotNull
public Wire writeComment(CharSequence s)

Specified by:

writeComment in interface WireOut

addPadding

@NotNull
public WireOut addPadding(int paddingToAdd)

Specified by:

addPadding in interface WireOut

newLongReference

@NotNull
public net.openhft.chronicle.core.values.LongValue newLongReference()

Specified by:

newLongReference in interface WireCommon

Returns:

a LongValue which appropriate for this wire.

newIntReference

@NotNull
public net.openhft.chronicle.core.values.IntValue newIntReference()

Specified by:

newIntReference in interface WireCommon

Returns:

an IntValue which appropriate for this wire.

newLongArrayReference

@NotNull
public net.openhft.chronicle.bytes.ref.BinaryLongArrayReference newLongArrayReference()

Specified by:

newLongArrayReference in interface WireCommon

Returns:

a LongArrayValue which appropriate for this wire.