net.openhft.chronicle.wire

Class YamlWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

net.openhft.chronicle.wire.YamlWireOut<YamlWire>

net.openhft.chronicle.wire.YamlWire

All Implemented Interfaces:

DocumentWritten, MarshallableIn, MarshallableOut, Wire, WireCommon, WireIn, WireOut

public class YamlWire
extends YamlWireOut<YamlWire>

YAML Based wire format

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

sb, TYPE, valueOut

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
YamlWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)
YamlWire(@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.
static String	asText(@NotNull Wire wire)
void	clear() Resets the state of the underlying Bytes stored by the wire.
protected void	consumeDocumentStart()
void	consumePadding()
void	copyTo(@NotNull WireOut wire)
protected @NotNull net.openhft.chronicle.wire.YamlWire.TextValueIn	createValueIn()
String	dumpContext()
void	endEvent()
static @NotNull YamlWire	from(@NotNull String text)
static @NotNull YamlWire	fromFile(String name)
@NotNull ValueIn	getValueIn() Obtain the value in for advanced use (typically after a call to readEvent above)
boolean	hasMetaDataPrefix()
boolean	hintReadInputOrder()
protected void	initReadContext()
boolean	isBinary() Determine whether direct access to the underlying byte() makes sense or should it be treated as text
boolean	isEndEvent()
boolean	isNotEmptyAfterPadding() This consumes any padding before checking if readRemaining() > 0
@NotNull VanillaMethodReaderBuilder	methodReaderBuilder()
<T> T	methodWriter(@NotNull Class<T> tClass, Class... additional) Proxy an interface so each message called is written for replay.
<T> @NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T>	methodWriterBuilder(@NotNull Class<T> tClass) Return a builder for a proxy an interface so each message called is written for method.
@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.core.values.LongArrayValues	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(String keyName)
@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 Wire	readComment(@NotNull StringBuilder s)
boolean	readDocument(long position, @Nullable ReadMarshallable metaDataConsumer, @Nullable ReadMarshallable dataConsumer)
boolean	readDocument(@Nullable ReadMarshallable metaDataConsumer, @Nullable ReadMarshallable dataConsumer)
<K> K	readEvent(@NotNull Class<K> expectedClass) Read a field which might be an object of any type.
long	readEventNumber()
protected @NotNull StringBuilder	readField(@NotNull StringBuilder sb)
@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
void	startEvent()
String	toString()
@NotNull YamlWire	useBinaryDocuments()
boolean	useSelfDescribingMessage(@NotNull net.openhft.chronicle.bytes.CommonMarshallable object) Should this wire write the object as a Marshallable or BytesMarshallable
@NotNull YamlWire	useTextDocuments()
@NotNull DocumentContext	writingDocument(boolean metaData) Start a new DocumentContext, must always call close() when done.
boolean	writingIsComplete()

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

acquireStringBuilder, addPadding, addTimeStamps, addTimeStamps, append, append, appendU4, bytes, createValueOut, dropDefault, escape0, getValueOut, needsQuotes, trimFirstCurly, trimFirstCurly, write, write, write, writeComment, writeEndEvent, writeEvent, writeObject, writeStartEvent

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

newYamlWireOnHeap

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

asText, hasMore, isEmpty, rawReadData, readAlignTo, readAllAsMap, readDataHeader, readEventName

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

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

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

padToCacheAlign, writeAlignTo, writeAllAsMap, writeDocument, writeEventId, writeEventId, writeEventName, writeEventName, writeNotCompleteDocument, writingDocument

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

newTwoLongReference

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

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

Constructor Detail

YamlWire

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

YamlWire

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

Method Detail

fromFile

@NotNull
public static @NotNull YamlWire fromFile(String name)
                                           throws IOException

Throws:

IOException

from

@NotNull
public static @NotNull YamlWire from(@NotNull
                                              @NotNull String text)

asText

public static String asText(@NotNull
                            @NotNull Wire wire)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

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

Returns:

Is this a binary protocol

hintReadInputOrder

public boolean hintReadInputOrder()

methodWriter

@NotNull
public <T> T methodWriter(@NotNull
                                   @NotNull Class<T> tClass,
                                   Class... additional)

Description copied from interface: MarshallableOut

Proxy an interface so each message called is written for replay.

Parameters:

tClass - primary interface

additional - any additional interfaces

Returns:

a proxy which implements the primary interface (additional interfaces have to be cast)

methodWriterBuilder

@NotNull
public <T> @NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T> methodWriterBuilder(@NotNull
                                                                                                    @NotNull Class<T> tClass)

Description copied from interface: MarshallableOut

Return a builder for a proxy an interface so each message called is written for method.

Parameters:

tClass - primary interface

Returns:

a builder for a proxy which implements the interface

methodReaderBuilder

@NotNull
public @NotNull VanillaMethodReaderBuilder methodReaderBuilder()

writingDocument

@NotNull
public @NotNull DocumentContext writingDocument(boolean metaData)

Description copied from interface: DocumentWritten

Start a new DocumentContext, must always call close() when done.

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: DocumentWritten

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

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

Returns:

the document context

initReadContext

protected void initReadContext()

useBinaryDocuments

@NotNull
public @NotNull YamlWire useBinaryDocuments()

useTextDocuments

@NotNull
public @NotNull YamlWire useTextDocuments()

readingDocument

@NotNull
public @NotNull DocumentContext readingDocument(long readLocation)

createValueIn

@NotNull
protected @NotNull net.openhft.chronicle.wire.YamlWire.TextValueIn createValueIn()

toString

public String toString()

Overrides:

toString in class Object

copyTo

public void copyTo(@NotNull
                   @NotNull WireOut wire)
            throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

readEventNumber

public long readEventNumber()

Specified by:

readEventNumber in interface WireIn

Overrides:

readEventNumber in class AbstractWire

Returns:

field number or Long.MIN_VALUE if no number.

read

@NotNull
public @NotNull ValueIn read()

Description copied from interface: WireIn

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

readField

@NotNull
protected @NotNull StringBuilder readField(@NotNull
                                                    @NotNull StringBuilder sb)

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

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

isNotEmptyAfterPadding

public boolean isNotEmptyAfterPadding()

Description copied from interface: WireIn

This consumes any padding before checking if readRemaining() > 0

NOTE: This method only works inside a document. Call it just before a document and it won't know not to read the read in case there is padding.

Returns:

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

consumePadding

public void consumePadding()

readingPeekYaml

@NotNull
public @NotNull String readingPeekYaml()

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.

read

@NotNull
public @NotNull ValueIn read(String keyName)

dumpContext

public String dumpContext()

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.

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)

readComment

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

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

consumeDocumentStart

protected void consumeDocumentStart()

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.

Returns:

a new LongValue

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.

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

Returns:

use Marshallable

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.

Returns:

a new IntValue.

newLongArrayReference

@NotNull
public @NotNull net.openhft.chronicle.core.values.LongArrayValues newLongArrayReference()

Description copied from interface: WireCommon

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

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.

Returns:

a new IntArrayValues

startEvent

public void startEvent()

isEndEvent

public boolean isEndEvent()

endEvent

public void endEvent()

reset

public void reset()

Description copied from interface: WireCommon

Reset the state of the wire

hasMetaDataPrefix

public boolean hasMetaDataPrefix()

readDocument

public boolean readDocument(@Nullable
                            @Nullable ReadMarshallable metaDataConsumer,
                            @Nullable
                            @Nullable ReadMarshallable dataConsumer)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

readDocument

public boolean readDocument(long position,
                            @Nullable
                            @Nullable ReadMarshallable metaDataConsumer,
                            @Nullable
                            @Nullable ReadMarshallable dataConsumer)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

writingIsComplete

public boolean writingIsComplete()

Returns:

true unless there is an incomplete/chained message