net.openhft.chronicle.wire

Class YamlWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

net.openhft.chronicle.wire.YamlWire

All Implemented Interfaces:

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

public class YamlWire
extends AbstractWire
implements Wire

YAML Based wire format

Nested Class Summary

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

WireIn.HeaderType

Field Summary

Fields

Modifier and Type	Field and Description
static net.openhft.chronicle.bytes.BytesStore	TYPE

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.
@NotNull WireOut	addPadding(int paddingToAdd)
boolean	addTimeStamps()
YamlWire	addTimeStamps(boolean addTimeStamps)
void	append(@NotNull CharSequence cs)
void	append(@NotNull CharSequence cs, int offset, int length)
static String	asText(@NotNull Wire wire)
@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.
protected void	consumeDocumentStart()
void	consumePadding()
void	copyTo(@NotNull WireOut wire)
protected @NotNull net.openhft.chronicle.wire.YamlWire.TextValueIn	createValueIn()
protected @NotNull net.openhft.chronicle.wire.YamlWire.TextValueOut	createValueOut()
@NotNull WireOut	dropDefault(boolean dropDefault)
String	dumpContext()
void	endEvent()
protected void	escape0(@NotNull CharSequence s, @NotNull net.openhft.chronicle.wire.Quotes quotes)
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)
@NotNull ValueOut	getValueOut() Obtain the value out
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.
protected @NotNull net.openhft.chronicle.wire.Quotes	needsQuotes(@NotNull CharSequence s)
@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()
boolean	trimFirstCurly()
YamlWire	trimFirstCurly(boolean trimFirstCurly)
@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 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(@NotNull CharSequence s)
void	writeEndEvent()
ValueOut	writeEvent(Class expectedType, Object eventKey)
void	writeObject(Object o) Deprecated.
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, endUse, enterHeader, forceNotInsideHeader, headerNumber, headerNumber, headNumberCheck, isInsideHeader, notCompleteIsNotPresent, notCompleteIsNotPresent, objectInput, objectOutput, parent, parent, pauser, pauser, readAndSetLength, readDataHeader, readFirstHeader, readFirstHeader, readMetaDataHeader, startUse, 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

headerNumber, newYamlWireOnHeap

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

asText, commentListener, hasMore, isEmpty, objectInput, rawReadData, readAlignTo, readAllAsMap, readAndSetLength, readDataHeader, readDataHeader, readEventName, readFirstHeader, readFirstHeader, readMetaDataHeader

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

enterHeader, objectOutput, padToCacheAlign, updateFirstHeader, updateHeader, writeAlignTo, writeAllAsMap, writeDocument, writeEndOfWire, writeEventId, writeEventId, writeEventName, writeEventName, writeFirstHeader, writeNotCompleteDocument, writingDocument

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

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

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

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

Field Detail

TYPE

public static final net.openhft.chronicle.bytes.BytesStore TYPE

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

Specified by:

fromFile in interface Wire

Throws:

IOException

from

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

asText

public static String asText(@NotNull
                            @NotNull Wire wire)

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

hintReadInputOrder

public boolean hintReadInputOrder()

Specified by:

hintReadInputOrder in interface WireIn

addTimeStamps

public boolean addTimeStamps()

addTimeStamps

public YamlWire addTimeStamps(boolean addTimeStamps)

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.

Specified by:

methodWriter in interface MarshallableOut

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.

Specified by:

methodWriterBuilder in interface MarshallableOut

Parameters:

tClass - primary interface

Returns:

a builder for a proxy which implements the interface

methodReaderBuilder

@NotNull
public @NotNull VanillaMethodReaderBuilder methodReaderBuilder()

Specified by:

methodReaderBuilder in interface MarshallableIn

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

initReadContext

protected void initReadContext()

useBinaryDocuments

@NotNull
public @NotNull YamlWire useBinaryDocuments()

useTextDocuments

@NotNull
public @NotNull YamlWire useTextDocuments()

readingDocument

@NotNull
public @NotNull DocumentContext readingDocument(long readLocation)

Specified by:

readingDocument in interface WireIn

createValueOut

@NotNull
protected @NotNull net.openhft.chronicle.wire.YamlWire.TextValueOut createValueOut()

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)

Specified by:

copyTo in interface WireIn

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.

Specified by:

read in interface WireIn

readField

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

readEvent

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

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

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.

Specified by:

isNotEmptyAfterPadding in interface WireIn

Returns:

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

consumePadding

public void consumePadding()

Specified by:

consumePadding in interface WireIn

readingPeekYaml

@NotNull
public @NotNull String readingPeekYaml()

Specified by:

readingPeekYaml 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

read

@NotNull
public @NotNull ValueIn read(String keyName)

Specified by:

read in interface WireIn

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.

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

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

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

write

@NotNull
public @NotNull ValueOut write()

Description copied from interface: WireOut

Write an empty filed marker

Specified by:

write 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

writeEvent

public ValueOut writeEvent(Class expectedType,
                           Object eventKey)

Specified by:

writeEvent in interface WireOut

dropDefault

@NotNull
public @NotNull WireOut dropDefault(boolean dropDefault)

Specified by:

dropDefault 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(@NotNull
                                           @NotNull CharSequence s)

Specified by:

writeComment in interface WireOut

addPadding

@NotNull
public @NotNull WireOut addPadding(int paddingToAdd)

Specified by:

addPadding in interface WireOut

escape0

protected void escape0(@NotNull
                       @NotNull CharSequence s,
                       @NotNull
                       @NotNull net.openhft.chronicle.wire.Quotes quotes)

needsQuotes

@NotNull
protected @NotNull net.openhft.chronicle.wire.Quotes needsQuotes(@NotNull
                                                                          @NotNull CharSequence s)

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.

Specified by:

newLongReference in interface WireCommon

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.

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

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

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

append

public void append(@NotNull
                   @NotNull CharSequence cs)

append

public void append(@NotNull
                   @NotNull CharSequence cs,
                   int offset,
                   int length)

writeObject

@Deprecated
public void writeObject(Object o)

Deprecated.

Please use valueIn().object(o)) instead.

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

trimFirstCurly

public boolean trimFirstCurly()

Returns:

whether the top level curly brackets is dropped

trimFirstCurly

public YamlWire trimFirstCurly(boolean trimFirstCurly)

Parameters:

trimFirstCurly - whether the top level curly brackets is dropped

startEvent

public void startEvent()

Specified by:

startEvent in interface WireIn

isEndEvent

public boolean isEndEvent()

Specified by:

isEndEvent in interface WireIn

endEvent

public void endEvent()

Specified by:

endEvent in interface WireIn

reset

public void reset()

Description copied from interface: WireCommon

Reset the state of the wire

Specified by:

reset in interface WireCommon

hasMetaDataPrefix

public boolean hasMetaDataPrefix()

Specified by:

hasMetaDataPrefix in interface WireIn

readDocument

public boolean readDocument(@Nullable
                            @Nullable ReadMarshallable metaDataConsumer,
                            @Nullable
                            @Nullable ReadMarshallable dataConsumer)

Specified by:

readDocument in interface WireIn

readDocument

public boolean readDocument(long position,
                            @Nullable
                            @Nullable ReadMarshallable metaDataConsumer,
                            @Nullable
                            @Nullable ReadMarshallable dataConsumer)

Specified by:

readDocument in interface WireIn