net.openhft.chronicle.wire

Class YamlWireOut<T extends YamlWireOut<T>>

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

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

All Implemented Interfaces:

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

Direct Known Subclasses:

TextWire, YamlWire

public abstract class YamlWireOut<T extends YamlWireOut<T>>
extends AbstractWire

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

Modifier and Type	Field and Description
protected StringBuilder	sb
static net.openhft.chronicle.bytes.BytesStore	TYPE
protected net.openhft.chronicle.wire.YamlWireOut.YamlValueOut	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

Modifier	Constructor and Description
protected	YamlWireOut(@NotNull net.openhft.chronicle.bytes.Bytes bytes, boolean use8bit)

Method Summary

Modifier and Type	Method and Description
protected @NotNull StringBuilder	acquireStringBuilder()
T	addPadding(int paddingToAdd)
boolean	addTimeStamps()
T	addTimeStamps(boolean addTimeStamps)
void	append(@NotNull CharSequence cs)
void	append(@NotNull CharSequence cs, int offset, int length)
protected void	appendU4(char ch)
@NotNull net.openhft.chronicle.bytes.Bytes<?>	bytes() Returns the underlying Bytes stored by the wire.
protected @NotNull net.openhft.chronicle.wire.YamlWireOut.YamlValueOut	createValueOut()
T	dropDefault(boolean dropDefault)
protected void	escape0(@NotNull CharSequence s, @NotNull net.openhft.chronicle.wire.Quotes quotes)
@NotNull ValueOut	getValueOut() Obtain the value out
protected @NotNull net.openhft.chronicle.wire.Quotes	needsQuotes(@NotNull CharSequence s)
boolean	trimFirstCurly()
T	trimFirstCurly(boolean trimFirstCurly)
@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.
T	writeComment(@NotNull CharSequence s)
void	writeEndEvent()
ValueOut	writeEvent(Class expectedType, Object eventKey)
void	writeObject(Object o)
void	writeStartEvent() Start an event object, mostly for internal use.

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

bytesComment, classLookup, classLookup, clear, 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, toString, wait, wait, wait

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

fromFile, newYamlWireOnHeap

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

asText, consumePadding, copyTo, endEvent, getValueIn, hasMetaDataPrefix, hasMore, hintReadInputOrder, isEmpty, isEndEvent, isNotEmptyAfterPadding, rawReadData, read, read, read, read, readAlignTo, readAllAsMap, readComment, readDataHeader, readDocument, readDocument, readEvent, readEventName, readingDocument, readingDocument, readingPeekYaml, 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

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

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

isBinary, newBooleanReference, newIntArrayReference, newIntReference, newLongArrayReference, newLongReference, newTwoLongReference, reset, useSelfDescribingMessage

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

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

Field Detail

TYPE

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

valueOut

protected final net.openhft.chronicle.wire.YamlWireOut.YamlValueOut valueOut

sb

protected final StringBuilder sb

Constructor Detail

YamlWireOut

protected YamlWireOut(@NotNull
                      @NotNull net.openhft.chronicle.bytes.Bytes bytes,
                      boolean use8bit)

Method Detail

addTimeStamps

public boolean addTimeStamps()

addTimeStamps

public T addTimeStamps(boolean addTimeStamps)

createValueOut

@NotNull
protected @NotNull net.openhft.chronicle.wire.YamlWireOut.YamlValueOut createValueOut()

acquireStringBuilder

@NotNull
protected @NotNull StringBuilder acquireStringBuilder()

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

write

@NotNull
public @NotNull ValueOut write(@NotNull
                                        @NotNull WireKey key)

Description copied from interface: WireOut

Write a key for wires that support fields.

write

@NotNull
public @NotNull ValueOut write(@NotNull
                                        @NotNull CharSequence name)

writeEvent

public ValueOut writeEvent(Class expectedType,
                           Object eventKey)
                    throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

dropDefault

@NotNull
public T dropDefault(boolean dropDefault)

getValueOut

@NotNull
public @NotNull ValueOut getValueOut()

Description copied from interface: WireOut

Obtain the value out

writeComment

@NotNull
public T writeComment(@NotNull
                               @NotNull CharSequence s)

addPadding

@NotNull
public T addPadding(int paddingToAdd)

escape0

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

appendU4

protected void appendU4(char ch)

needsQuotes

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

append

public void append(@NotNull
                   @NotNull CharSequence cs)

append

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

writeObject

public void writeObject(Object o)
                 throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

writeStartEvent

public void writeStartEvent()

Description copied from interface: WireOut

Start an event object, mostly for internal use.

writeEndEvent

public void writeEndEvent()

trimFirstCurly

public boolean trimFirstCurly()

Returns:

whether the top level curly brackets is dropped

trimFirstCurly

public T trimFirstCurly(boolean trimFirstCurly)

Parameters:

trimFirstCurly - whether the top level curly brackets is dropped