net.openhft.chronicle.wire

Class YamlWireOut<T extends YamlWireOut<T>>

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

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

Type Parameters:

T - The type that extends YamlWireOut

All Implemented Interfaces:

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

Direct Known Subclasses:

TextWire, YamlWire

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

Provides functionality for writing data in a YAML-based wire format. This class encapsulates methods and attributes to handle data serialization into YAML 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) Constructs a new instance of YamlWireOut with specified bytes and 8-bit flag.

Method Summary

Modifier and Type	Method and Description
protected @NotNull StringBuilder	acquireStringBuilder() Acquires and clears the internal StringBuilder sb for use.
T	addPadding(int paddingToAdd) Adds padding to the wire.
boolean	addTimeStamps() Checks if timestamps should be added during serialization.
T	addTimeStamps(boolean addTimeStamps) Configures whether to add timestamps during serialization.
void	append(@NotNull CharSequence cs) Appends the given CharSequence cs to the output bytes using either an 8-bit or UTF-8 encoding, depending on use8bit.
void	append(@NotNull CharSequence cs, int offset, int length) Appends a subsequence of the given CharSequence cs to the output bytes using either an 8-bit or UTF-8 encoding.
protected void	appendU4(char ch) Appends a 4-character hexadecimal Unicode representation of the given character ch to the output bytes.
@NotNull net.openhft.chronicle.bytes.Bytes<?>	bytes() Returns the underlying Bytes stored by the wire.
protected @NotNull net.openhft.chronicle.wire.YamlWireOut.YamlValueOut	createValueOut() Factory method used to obtain the main YamlValueOut.
T	dropDefault(boolean dropDefault)
protected void	escape0(@NotNull CharSequence textToEscape, @NotNull net.openhft.chronicle.wire.Quotes quoteStyle) Helper method to escape special characters in the given CharSequence textToEscape based on the requirements of the YAML format.
@NotNull ValueOut	getValueOut() Retrieves the interface for defining the output of a value that will be written to the stream.
protected @NotNull net.openhft.chronicle.wire.Quotes	needsQuotes(@NotNull CharSequence cs) Determines the type of quotes (if any) required for the given CharSequence cs based on the YAML format's escaping requirements.
boolean	trimFirstCurly() Returns a flag indicating if the top-level curly brackets in the serialized YAML should be dropped.
T	trimFirstCurly(boolean trimFirstCurly) Sets whether the top-level curly brackets in the serialized YAML should be dropped.
@NotNull ValueOut	write() Writes an empty field marker to the stream.
@NotNull ValueOut	write(@NotNull CharSequence name) Writes a CharSequence key to the stream.
@NotNull ValueOut	write(@NotNull WireKey key) Writes a WireKey to the stream.
T	writeComment(@NotNull CharSequence commentText) Writes a comment to the wire.
void	writeEndEvent()
ValueOut	writeEvent(Class<?> expectedType, Object eventKey) Writes an event to the stream based on the type and event key.
void	writeObject(Object o) Serialises a generic object.
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, generateTuples, generateTuples, 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

newYamlWireOnHeap

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

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, methodWriterBuilder, methodWriterBuilder, recordHistory, writeBytes, writeDocument, writeDocument, writeMap, writeMessage, writeMessage, writeText

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

rollbackIfNotComplete

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)

Constructs a new instance of YamlWireOut with specified bytes and 8-bit flag.

Parameters:

bytes - The bytes buffer for the wire format.

use8bit - Boolean flag indicating whether to use 8-bit values.

Method Detail

addTimeStamps

public boolean addTimeStamps()

Checks if timestamps should be added during serialization.

Returns:

True if timestamps should be added, otherwise false.

addTimeStamps

public T addTimeStamps(boolean addTimeStamps)

Configures whether to add timestamps during serialization. This method follows the builder pattern allowing chained method calls.

Parameters:

addTimeStamps - Boolean indicating whether to add timestamps.

Returns:

The current instance of YamlWireOut.

createValueOut

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

Factory method used to obtain the main YamlValueOut.

Returns:

A new YamlValueOut instance.

acquireStringBuilder

@NotNull
protected @NotNull StringBuilder acquireStringBuilder()

Acquires and clears the internal StringBuilder sb for use. The method ensures the StringBuilder's count is reset to 0 before returning.

Returns:

The internal StringBuilder after it has been cleared.

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

Writes an empty field marker to the stream.

Returns:

An interface to further define the output for the written value.

write

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

Description copied from interface: WireOut

Writes a WireKey to the stream. This method is typically used for wires that support fields with structured keys.

Parameters:

key - The WireKey to write to the stream.

Returns:

An interface to further define the output for the written value.

write

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

Description copied from interface: WireOut

Writes a CharSequence key to the stream. This provides flexibility to write non-standard keys to the wire.

Parameters:

name - The CharSequence key to write to the stream.

Returns:

An interface to further define the output for the written value.

writeEvent

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

Description copied from interface: WireOut

Writes an event to the stream based on the type and event key.

Parameters:

expectedType - The expected type of the event to write.

eventKey - The key of the event.

Returns:

An interface to further define the output for the written value.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error marshalling the event.

dropDefault

@NotNull
public T dropDefault(boolean dropDefault)

getValueOut

@NotNull
public @NotNull ValueOut getValueOut()

Description copied from interface: WireOut

Retrieves the interface for defining the output of a value that will be written to the stream.

Returns:

The interface to further define the output for the written value.

writeComment

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

Description copied from interface: WireOut

Writes a comment to the wire. Comments may be useful for debugging or providing context within the wire stream.

Parameters:

commentText - The comment to be written to the stream.

Returns:

This WireOut instance for method chaining.

addPadding

@NotNull
public T addPadding(int paddingToAdd)

Description copied from interface: WireOut

Adds padding to the wire. This is particularly useful for aligning data.

Parameters:

paddingToAdd - The amount of padding to add.

Returns:

This WireOut instance for method chaining.

escape0

protected void escape0(@NotNull
                       @NotNull CharSequence textToEscape,
                       @NotNull
                       @NotNull net.openhft.chronicle.wire.Quotes quoteStyle)

Helper method to escape special characters in the given CharSequence textToEscape based on the requirements of the YAML format. The method handles the specific escaping requirements for various control and special characters.

Parameters:

textToEscape - The CharSequence to be escaped.

quoteStyle - The quote style used to determine how certain characters are escaped.

appendU4

protected void appendU4(char ch)

Appends a 4-character hexadecimal Unicode representation of the given character ch to the output bytes. This is used for character escaping.

Parameters:

ch - The character to be converted to hexadecimal Unicode representation.

needsQuotes

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

Determines the type of quotes (if any) required for the given CharSequence cs based on the YAML format's escaping requirements. This method decides between using no quotes, single quotes, or double quotes.

Parameters:

cs - The CharSequence to be analyzed.

Returns:

The type of quotes required.

append

public void append(@NotNull
                   @NotNull CharSequence cs)

Appends the given CharSequence cs to the output bytes using either an 8-bit or UTF-8 encoding, depending on use8bit.

Parameters:

cs - CharSequence to be appended.

append

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

Appends a subsequence of the given CharSequence cs to the output bytes using either an 8-bit or UTF-8 encoding.

Parameters:

cs - CharSequence from which a subsequence will be appended.

offset - Starting index of the subsequence.

length - Length of the subsequence.

writeObject

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

Serialises a generic object. Iterables and maps are unpacked, while other types delegate to ValueOut.object(Object) or ValueOut.typedMarshallable(WriteMarshallable) as appropriate.

Parameters:

o - The object to be serialized.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if an error occurs during serialization.

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 a flag indicating if the top-level curly brackets in the serialized YAML should be dropped.

Returns:

true if the top-level curly brackets should be dropped; false otherwise.

trimFirstCurly

public T trimFirstCurly(boolean trimFirstCurly)

Sets whether the top-level curly brackets in the serialized YAML should be dropped.

Parameters:

trimFirstCurly - true to drop the top-level curly brackets; false to include them.

Returns:

The current instance of YamlWireOut (fluent API style).