net.openhft.chronicle.wire

Class RawWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

net.openhft.chronicle.wire.RawWire

All Implemented Interfaces:

DocumentWritten, 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.WireOut

WireOut.EndOfWire

Field Summary

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

bytes, classLookup, commentListener, DEFAULT_USE_PADDING, parent, use8bit

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

MARSHALLABLE_IN_INTERN_SIZE

Constructor Summary

Constructors

Constructor and Description
RawWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)
RawWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean use8bit)

Method Summary

Modifier and Type	Method and Description
DocumentContext	acquireWritingDocument(boolean metaData) Start or reuse an existing a DocumentContext, optionally call close() when done.
@NotNull WireOut	addPadding(int paddingToAdd)
@NotNull net.openhft.chronicle.bytes.Bytes<?>	bytes() Returns the underlying Bytes stored by the wire.
void	clear() Resets the state of the underlying Bytes stored by the wire.
void	consumePadding()
void	copyTo(@NotNull WireOut wire)
@NotNull ValueIn	getValueIn() Obtain the value in for advanced use (typically after a call to readEvent above)
@NotNull ValueOut	getValueOut() Obtain the value out
boolean	isBinary() Determine whether direct access to the underlying byte() makes sense or should it be treated as text
@NotNull net.openhft.chronicle.core.values.BooleanValue	newBooleanReference() Creates and returns a new BooleanValue.
@NotNull net.openhft.chronicle.core.values.IntArrayValues	newIntArrayReference() Creates and returns a new IntArrayValues.
@NotNull net.openhft.chronicle.core.values.IntValue	newIntReference() Creates and returns a new IntValue.
@NotNull net.openhft.chronicle.bytes.ref.BinaryLongArrayReference	newLongArrayReference() Creates and returns a new LongArrayValues.
@NotNull net.openhft.chronicle.core.values.LongValue	newLongReference() Creates and returns a new LongValue.
@NotNull ValueIn	read() Read the field if present, or empty string if not present.
@NotNull ValueIn	read(@NotNull StringBuilder name) Read the field if present, or empty string if not present.
@NotNull ValueIn	read(@NotNull WireKey key) Read the field if present which must match the WireKey.
@NotNull WireIn	readAlignTo(int alignment)
@NotNull Wire	readComment(@NotNull StringBuilder sb)
<K> K	readEvent(@NotNull Class<K> expectedClass) Read a field which might be an object of any type.
@NotNull ValueIn	readEventName(@NotNull StringBuilder name) Read a field, or string which is always written, even for formats which might drop the field such as RAW.
@NotNull 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
@NotNull DocumentContext	readingDocument(long readLocation)
@NotNull String	readingPeekYaml()
void	reset() Reset the state of the wire
String	toString()
boolean	useSelfDescribingMessage(@NotNull net.openhft.chronicle.bytes.CommonMarshallable object) Should this wire write the object as a Marshallable or BytesMarshallable
@NotNull ValueOut	write() Write an empty filed marker
@NotNull ValueOut	write(@NotNull CharSequence name)
@NotNull ValueOut	write(@NotNull WireKey key) Write a key for wires that support fields.
@NotNull Wire	writeComment(CharSequence s)
void	writeEndEvent()
@NotNull ValueOut	writeEventName(@NotNull CharSequence name)
@NotNull ValueOut	writeEventName(@NotNull WireKey key) Always write a key.
void	writeStartEvent() Start an event object, mostly for internal use.
@NotNull DocumentContext	writingDocument(boolean metaData) This will increment the headerNumber as appropriate if successful

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

bytesComment, classLookup, classLookup, commentListener, endOfWire, enterHeader, forceNotInsideHeader, headerNumber, headerNumber, headNumberCheck, isInsideHeader, notCompleteIsNotPresent, notCompleteIsNotPresent, objectInput, objectOutput, parent, parent, pauser, pauser, readAndSetLength, readDataHeader, readEventNumber, readFirstHeader, readFirstHeader, readMetaDataHeader, updateFirstHeader, updateFirstHeader, updateHeader, usePadding, usePadding, writeEndOfWire, writeFirstHeader

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

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

asText, commentListener, endEvent, hasMetaDataPrefix, hasMore, hintReadInputOrder, isEmpty, isEndEvent, isNotEmptyAfterPadding, objectInput, rawReadData, read, readAllAsMap, readAndSetLength, readDataHeader, readDataHeader, readDocument, readDocument, readEventNumber, readFirstHeader, readFirstHeader, readMetaDataHeader, startEvent

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, endOfWire, enterHeader, objectOutput, padToCacheAlign, updateFirstHeader, updateFirstHeader, updateHeader, writeAlignTo, writeAllAsMap, writeDocument, writeEndOfWire, writeEvent, writeEventId, writeEventId, writeFirstHeader, writeNotCompleteDocument, writingDocument, writingIsComplete

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

bytesComment, classLookup, classLookup, headerNumber, newTwoLongReference, notCompleteIsNotPresent, notCompleteIsNotPresent, parent, parent, pauser, pauser, usePadding, usePadding

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

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

Constructor Detail

RawWire

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

RawWire

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

Method Detail

reset

public void reset()

Description copied from interface: WireCommon

Reset the state of the wire

Specified by:

reset in interface WireCommon

isBinary

public boolean isBinary()

Description copied from interface: WireCommon

Determine whether direct access to the underlying byte() makes sense or should it be treated as text

Specified by:

isBinary in interface WireCommon

Returns:

Is this a binary protocol

writingDocument

@NotNull
public @NotNull DocumentContext writingDocument(boolean metaData)

Description copied from interface: WireOut

This will increment the headerNumber as appropriate if successful

Specified by:

writingDocument in interface DocumentWritten

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

acquireWritingDocument

public DocumentContext acquireWritingDocument(boolean metaData)

Description copied from interface: MarshallableOut

Start or reuse an existing a DocumentContext, optionally call close() when done.

Specified by:

acquireWritingDocument in interface DocumentWritten

Specified by:

acquireWritingDocument in interface MarshallableOut

Specified by:

acquireWritingDocument in interface WireOut

readingDocument

@NotNull
public @NotNull 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 @NotNull DocumentContext readingDocument(long readLocation)

Specified by:

readingDocument in interface WireIn

consumePadding

public void consumePadding()

Specified by:

consumePadding in interface WireIn

readingPeekYaml

@NotNull
public @NotNull String readingPeekYaml()

Specified by:

readingPeekYaml in interface WireIn

copyTo

public void copyTo(@NotNull
                   @NotNull WireOut wire)

Specified by:

copyTo in interface WireIn

read

@NotNull
public @NotNull 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 @NotNull ValueIn read(@NotNull
                                      @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 @NotNull ValueIn readEventName(@NotNull
                                               @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
                                 @NotNull Class<K> expectedClass)
                          throws net.openhft.chronicle.core.io.InvalidMarshallableException

Description copied from interface: WireIn

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

Use getValueIn() to read the value for this event

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

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

read

@NotNull
public @NotNull ValueIn read(@NotNull
                                      @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 @NotNull ValueIn getValueIn()

Description copied from interface: WireIn

Obtain the value in for advanced use (typically after a call to readEvent above)

Specified by:

getValueIn in interface WireIn

readComment

@NotNull
public @NotNull Wire readComment(@NotNull
                                          @NotNull StringBuilder sb)

Specified by:

readComment in interface WireIn

clear

public void clear()

Description copied from interface: WireCommon

Resets the state of the underlying Bytes stored by the wire.

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 @NotNull net.openhft.chronicle.core.values.BooleanValue newBooleanReference()

Description copied from interface: WireCommon

Creates and returns a new BooleanValue. The BooleanValue implementation that is returned depends on the wire implementation.

Specified by:

newBooleanReference in interface WireCommon

Returns:

a new BooleanValue.

useSelfDescribingMessage

public boolean useSelfDescribingMessage(@NotNull
                                        @NotNull net.openhft.chronicle.bytes.CommonMarshallable object)

Description copied from interface: WireCommon

Should this wire write the object as a Marshallable or BytesMarshallable

Specified by:

useSelfDescribingMessage in interface WireCommon

Returns:

use Marshallable

bytes

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

Description copied from interface: WireCommon

Returns the underlying Bytes stored by the wire.

Specified by:

bytes in interface WireCommon

Overrides:

bytes in class AbstractWire

Returns:

the underlying Bytes stored by the wire

readAlignTo

@NotNull
public @NotNull WireIn readAlignTo(int alignment)

Specified by:

readAlignTo in interface WireIn

toString

public String toString()

Overrides:

toString in class Object

write

@NotNull
public @NotNull ValueOut write()

Description copied from interface: WireOut

Write an empty filed marker

Specified by:

write in interface WireOut

writeEventName

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

Specified by:

writeEventName in interface WireOut

writeStartEvent

public void writeStartEvent()

Description copied from interface: WireOut

Start an event object, mostly for internal use.

Specified by:

writeStartEvent in interface WireOut

writeEndEvent

public void writeEndEvent()

Specified by:

writeEndEvent in interface WireOut

write

@NotNull
public @NotNull ValueOut write(@NotNull
                                        @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 @NotNull ValueOut write(@NotNull
                                        @NotNull CharSequence name)

Specified by:

write in interface WireOut

getValueOut

@NotNull
public @NotNull ValueOut getValueOut()

Description copied from interface: WireOut

Obtain the value out

Specified by:

getValueOut in interface WireOut

writeComment

@NotNull
public @NotNull Wire writeComment(CharSequence s)

Specified by:

writeComment in interface WireOut

addPadding

@NotNull
public @NotNull WireOut addPadding(int paddingToAdd)

Specified by:

addPadding in interface WireOut

newLongReference

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

Description copied from interface: WireCommon

Creates and returns a new LongValue. The LongValue implementation that is returned depends on the wire implementation.

Specified by:

newLongReference in interface WireCommon

Returns:

a new LongValue

newIntReference

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

Description copied from interface: WireCommon

Creates and returns a new IntValue. The IntValue implementation that is returned depends on the wire implementation.

Specified by:

newIntReference in interface WireCommon

Returns:

a new IntValue.

newLongArrayReference

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

Description copied from interface: WireCommon

Creates and returns a new LongArrayValues. The LongArrayValues implementation that is returned depends on the wire implementation.

Specified by:

newLongArrayReference in interface WireCommon

Returns:

a new LongArrayValues

newIntArrayReference

@NotNull
public @NotNull net.openhft.chronicle.core.values.IntArrayValues newIntArrayReference()

Description copied from interface: WireCommon

Creates and returns a new IntArrayValues. The IntArrayValues implementation that is returned depends on the wire implementation.

Specified by:

newIntArrayReference in interface WireCommon

Returns:

a new IntArrayValues