net.openhft.chronicle.wire

Class RawWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

net.openhft.chronicle.wire.RawWire

All Implemented Interfaces:

MarshallableIn, MarshallableOut, Wire, WireCommon, WireIn, WireOut

public class RawWire
extends AbstractWire
implements Wire

This format writes just the data, without meta data.

Nested Class Summary

Nested classes/interfaces inherited from interface net.openhft.chronicle.wire.WireIn

WireIn.HeaderType

Nested classes/interfaces inherited from interface net.openhft.chronicle.wire.MarshallableOut

MarshallableOut.Padding

Field Summary

Fields inherited from class net.openhft.chronicle.wire.AbstractWire

ASSERTIONS, bytes, parent

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

DEFAULT_SAFE_LENGTH, TRY_WRITE_HEADER_FAILED

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()
net.openhft.chronicle.core.pool.ClassLookup	classLookup()
void	classLookup(net.openhft.chronicle.core.pool.ClassLookup classLookup) Define how classes should be looked up.
void	clear() reset the state of the current wire for reuse.
void	consumePadding()
void	copyTo(WireOut wire)
void	endEvent()
ValueIn	getValueIn() Obtain the value in (for internal use)
ValueOut	getValueOut() Obtain the value out
net.openhft.chronicle.core.values.BooleanValue	newBooleanReference()
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)
<K> K	readEvent(Class<K> expectedClass) Read a field which might be an object of any type.
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() equivalent to WireIn.readDocument(net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.wire.ReadMarshallable) but with out the use of a lambda expression
DocumentContext	readingDocument(long readLocation)
String	readingPeekYaml()
void	startEvent() Start an event object, mostly for internal use.
String	toString()
ValueOut	write() Write an empty filed marker
ValueOut	write(CharSequence name)
ValueOut	write(WireKey key) Write a key for wires that support fields.
Wire	writeComment(CharSequence s)
ValueOut	writeEventName(CharSequence name)
ValueOut	writeEventName(WireKey key) Always write a key.
DocumentContext	writingDocument(boolean metaData) This will increment the headerNumber as appropriate if successful

Methods inherited from class net.openhft.chronicle.wire.AbstractWire

bytesComment, endUse, forceNotInsideHeader, headerNumber, headerNumber, headNumberCheck, isInsideHeader, notCompleteIsNotPresent, notCompleteIsNotPresent, objectInput, objectOutput, parent, parent, pauser, pauser, readAndSetLength, readDataHeader, readEventNumber, readFirstHeader, readMetaDataHeader, startUse, tryWriteHeader, updateFirstHeader, updateHeader, writeEndOfWire, writeFirstHeader, writeHeaderOfUnknownLength

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, headerNumber

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

asText, hasMore, isEmpty, isNotEmptyAfterPadding, objectInput, rawReadData, read, readAllAsMap, readAndSetLength, readDataHeader, readDataHeader, readDocument, readDocument, readEventNumber, readFirstHeader, readMetaDataHeader

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

methodReader, methodReaderBuilder, readBytes, readBytes, readDocument, readMap, readText, readText

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

dropDefault, objectOutput, padToCacheAlign, tryWriteHeader, updateFirstHeader, updateHeader, writeAlignTo, writeAllAsMap, writeDocument, writeEndOfWire, writeEvent, writeEventId, writeFirstHeader, writeHeader, writeHeaderOfUnknownLength, writeHeaderOfUnknownLength, writeNotCompleteDocument, writingDocument

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

bytesComment, endUse, headerNumber, newTwoLongReference, notCompleteIsNotPresent, notCompleteIsNotPresent, parent, parent, pauser, pauser, startUse

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

methodWriter, methodWriter, methodWriterBuilder, padToCacheAlignMode, recordHistory, writeBytes, writeDocument, writeDocument, writeMap, writeMessage, writeText

Constructor Detail

RawWire

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

RawWire

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

Method Detail

classLookup

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

Description copied from interface: WireCommon

Define how classes should be looked up.

Specified by:

classLookup in interface WireCommon

Overrides:

classLookup in class AbstractWire

Parameters:

classLookup - to use

classLookup

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

Specified by:

classLookup in interface WireCommon

Overrides:

classLookup in class AbstractWire

Returns:

the current implementation for looking up classes.

writingDocument

@NotNull
public DocumentContext writingDocument(boolean metaData)

Description copied from interface: WireOut

This will increment the headerNumber as appropriate if successful

Specified by:

writingDocument in interface MarshallableOut

Specified by:

writingDocument in interface WireOut

Parameters:

metaData - if true the document context will be used for writing meta data, otherwise data

Returns:

a document context used for witting

readingDocument

@NotNull
public DocumentContext readingDocument()

Description copied from interface: WireIn

equivalent to WireIn.readDocument(net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.wire.ReadMarshallable) but with out the use of a lambda expression

Specified by:

readingDocument in interface MarshallableIn

Specified by:

readingDocument in interface WireIn

Returns:

the document context

readingDocument

@NotNull
public DocumentContext readingDocument(long readLocation)

Specified by:

readingDocument in interface WireIn

consumePadding

public void consumePadding()

Specified by:

consumePadding in interface WireIn

readingPeekYaml

@NotNull
public String readingPeekYaml()

Specified by:

readingPeekYaml in interface WireIn

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

readEvent

@Nullable
public <K> K readEvent(@NotNull
                                 Class<K> expectedClass)

Description copied from interface: WireIn

Read a field which might be an object of any type.

Specified by:

readEvent in interface WireIn

Parameters:

expectedClass - to use as a hint, or Object.class if no hint available.

Returns:

an instance of expectedClass

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()

Description copied from interface: WireCommon

reset the state of the current wire for reuse.

Specified by:

clear in interface WireCommon

Specified by:

clear in interface WireIn

Specified by:

clear in interface WireOut

Overrides:

clear in class AbstractWire

newBooleanReference

@NotNull
public net.openhft.chronicle.core.values.BooleanValue newBooleanReference()

Specified by:

newBooleanReference in interface WireCommon

Returns:

a BooleanValue which appropriate for this wire.

bytes

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

Specified by:

bytes in interface WireCommon

Overrides:

bytes in class AbstractWire

Returns:

the underlying Bytes

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

writeEventName

@NotNull
public ValueOut writeEventName(@NotNull
                                        CharSequence name)

Specified by:

writeEventName in interface WireOut

startEvent

public void startEvent()

Description copied from interface: WireOut

Start an event object, mostly for internal use.

Specified by:

startEvent in interface WireOut

endEvent

public void endEvent()

Specified by:

endEvent 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

write

@NotNull
public ValueOut write(@NotNull
                               CharSequence name)

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.