YamlWire (OpenHFT/Chronicle-Wire 2.26ea3 API)

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, RollbackIfNotCompleteNotifier, Wire, WireCommon, WireIn, WireOut
```
public class YamlWire
extends YamlWireOut<YamlWire>
```
Represents a YAML-based wire format designed for efficient parsing and serialization of data. The YamlWire class extends YamlWireOut and utilizes a custom tokenizer to convert YAML tokens into byte sequences. It provides utility methods to read from and write to both byte buffers and files.

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)` Constructor that initializes the YamlWire with provided bytes.
`YamlWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean use8bit)` Constructor that initializes the YamlWire with provided bytes and a flag indicating the use of 8-bit.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentContext`	`acquireWritingDocument(boolean metaData)` Obtains a `DocumentContext` for writing.
`static String`	`asText(@NotNull Wire wire)` Converts the content of a given `Wire` object into its string representation.
`void`	`clear()` Clears the WireIn, effectively resetting its state.
`protected void`	`consumeDocumentStart()` Consumes and skips the start of a YAML document, e.g., '---'.
`void`	`consumePadding()` Consumes and discards any padding that may exist between the current read position and the next piece of meaningful data.
`void`	`copyTo(@NotNull WireOut wire)` Copies the content from the current WireIn source to the provided WireOut destination.
`protected @NotNull net.openhft.chronicle.wire.YamlWire.TextValueIn`	`createValueIn()` Creates a new instance of `TextValueIn`.
`String`	`dumpContext()` Produces a dump of the current parsing context.
`void`	`endEvent()` Marks the end of an event or method flow.
`static @NotNull YamlWire`	`from(@NotNull String text)` Utility method to create a new YamlWire instance from a given text string.
`static @NotNull YamlWire`	`fromFile(String name)` Utility method to create a new YamlWire instance by reading bytes from a specified file.
`@NotNull ValueIn`	`getValueIn()` Obtains the value associated with a field or event for more advanced use cases.
`boolean`	`hasMetaDataPrefix()` Checks if the current position in the stream has a metadata prefix.
`boolean`	`hintReadInputOrder()` Provides a hint about the order in which the input should be read.
`protected void`	`initReadContext()` Initializes the reading context.
`boolean`	`isBinary()` Determine whether direct access to the underlying byte() makes sense or should it be treated as text
`boolean`	`isEndEvent()` Checks if the current position in the stream represents the end of an event or method flow.
`boolean`	`isNotEmptyAfterPadding()` This consumes any padding before checking if readRemaining() > 0
`@NotNull VanillaMethodReaderBuilder`	`methodReaderBuilder()` Provides a builder instance that can be used to construct and configure a `MethodReader` suitable for this reader's content.
`<T> T`	`methodWriter(@NotNull Class<T> tClass, Class<?>... additional)` Creates a proxy of the specified interfaces, where each method call on the proxy is written for replay.
`<T> @NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T>`	`methodWriterBuilder(@NotNull Class<T> tClass)` Returns a `MethodWriterBuilder` that can be used to create a proxy for an interface.
`@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()` Reads the next field if present, or returns an empty string if not present.
`@NotNull ValueIn`	`read(String keyName)` Reads the next field based on the provided field name.
`@NotNull ValueIn`	`read(@NotNull StringBuilder name)` Reads a specific field based on the provided field name.
`@NotNull ValueIn`	`read(@NotNull WireKey key)` Reads the next field if present.
`@NotNull Wire`	`readComment(@NotNull StringBuilder s)` Reads a comment from the Wire data and appends it to the provided StringBuilder.
`boolean`	`readDocument(long position, @Nullable ReadMarshallable metaDataConsumer, @Nullable ReadMarshallable dataConsumer)` Reads a document from a specific position, consuming both its metadata and data sections.
`boolean`	`readDocument(@Nullable ReadMarshallable metaDataConsumer, @Nullable ReadMarshallable dataConsumer)` Reads a document, consuming both its metadata and data sections.
`<K> K`	`readEvent(@NotNull Class<K> expectedClass)` Reads a field which may contain an object of any specified type.
`long`	`readEventNumber()` Reads the next event number.
`protected @NotNull StringBuilder`	`readField(@NotNull StringBuilder sb)` Reads a field from the current YamlToken and appends its content to the provided StringBuilder.
`@NotNull DocumentContext`	`readingDocument()` Provides a `DocumentContext` that can be used to read data from a source.
`@NotNull DocumentContext`	`readingDocument(long readLocation)` Provides a context for reading a document starting at a specific position.
`@NotNull String`	`readingPeekYaml()` Peeks at the content in the current WireIn instance and returns it as a YAML string.
`void`	`reset()` Resets the state of the YamlWire instance, clearing all buffers and contexts.
`void`	`rollbackIfNotComplete()` Rolls back the current operation if it is not complete.
`void`	`startEvent()` Marks the start of an event or method flow.
`String`	`toString()` Converts the current YamlWire instance into a string representation.
`@NotNull YamlWire`	`useBinaryDocuments()` Configures the YamlWire to use binary format for document reading and writing.
`boolean`	`useSelfDescribingMessage(@NotNull net.openhft.chronicle.bytes.CommonMarshallable object)` Should this wire write the object as a Marshallable or BytesMarshallable
`@NotNull YamlWire`	`useTextDocuments()` Configures the YamlWire to use text format for document reading and writing.
`@NotNull DocumentContext`	`writingDocument(boolean metaData)` Initiates a new `DocumentContext` for writing, with an option to include metadata.
`boolean`	`writingIsComplete()` Checks if the current writing operation is complete.

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

- Constructor Detail
  - YamlWire
```
public YamlWire(@NotNull
                @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                boolean use8bit)
```
    Constructor that initializes the YamlWire with provided bytes and a flag indicating the use of 8-bit.
    
    Parameters:
    
    bytes - Bytes from which YamlWire is initialized
    
    use8bit - A boolean flag to indicate the use of 8-bit
  - YamlWire
```
public YamlWire(@NotNull
                @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)
```
    Constructor that initializes the YamlWire with provided bytes. Defaults to not using 8-bit.
    
    Parameters:
    
    bytes - Bytes from which YamlWire is initialized
- Method Detail
  - fromFile
```
@NotNull
public static @NotNull YamlWire fromFile(String name)
                                           throws IOException
```
    Utility method to create a new YamlWire instance by reading bytes from a specified file.
    
    Parameters:
    
    name - Name of the file from which bytes are read
    
    Returns:
    
    A new YamlWire instance initialized with bytes from the specified file
    
    Throws:
    
    IOException - If there's an error in reading the file
  - from
```
@NotNull
public static @NotNull YamlWire from(@NotNull
                                              @NotNull String text)
```
    Utility method to create a new YamlWire instance from a given text string.
    
    Parameters:
    
    text - String from which the YamlWire instance is initialized
    
    Returns:
    
    A new YamlWire instance initialized from the given string
  - asText
```
public static String asText(@NotNull
                            @NotNull Wire wire)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Converts the content of a given Wire object into its string representation.
    
    Parameters:
    
    wire - The Wire object whose content needs to be converted to string.
    
    Returns:
    
    The string representation of the wire's content.
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - If the given wire's content cannot be marshalled.
  - 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()
```
    Description copied from interface: WireIn
    
    Provides a hint about the order in which the input should be read.
    
    Returns:
    
    true if the input should be read in a specific order, otherwise false.
  - methodWriter
```
@NotNull
public <T> T methodWriter(@NotNull
                                   @NotNull Class<T> tClass,
                                   Class<?>... additional)
```
    Description copied from interface: MarshallableOut
    
    Creates a proxy of the specified interfaces, where each method call on the proxy is written for replay. The primary interface is always implemented by the proxy, whereas any additional interfaces have to be cast to be accessed on the proxy.
    
    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
    
    Returns a MethodWriterBuilder that can be used to create a proxy for an interface. Each message called on the proxy will be written for replay. This is a convenience method that assumes metadata is not required.
    
    Parameters:
    
    tClass - The primary interface that the builder will cater to.
    
    Returns:
    
    A MethodWriterBuilder tailored for the given interface class.
  - methodReaderBuilder
```
@NotNull
public @NotNull VanillaMethodReaderBuilder methodReaderBuilder()
```
    Description copied from interface: MarshallableIn
    
    Provides a builder instance that can be used to construct and configure a MethodReader suitable for this reader's content. The builder offers flexibility in configuring the MethodReader to suit specific requirements.
    
    Returns:
    
    A VanillaMethodReaderBuilder for creating and customizing a MethodReader.
  - writingDocument
```
@NotNull
public @NotNull DocumentContext writingDocument(boolean metaData)
```
    Description copied from interface: DocumentWritten
    
    Initiates a new DocumentContext for writing, with an option to include metadata. It is imperative to always invoke the close() method on the context after completing the write operation.
    
    Parameters:
    
    metaData - A boolean indicating if metadata should be included during writing.
    
    Returns:
    
    A fresh DocumentContext tailored to the metadata preference.
  - acquireWritingDocument
```
public DocumentContext acquireWritingDocument(boolean metaData)
```
    Description copied from interface: DocumentWritten
    
    Obtains a DocumentContext for writing. This method either initiates a new context or reuses an existing one. Depending on the use case, calling the close() method on the context might be optional.
    
    Parameters:
    
    metaData - A boolean indicating if metadata should be included during writing.
    
    Returns:
    
    An existing or new DocumentContext tailored to the metadata preference.
  - readingDocument
```
@NotNull
public @NotNull DocumentContext readingDocument()
```
    Description copied from interface: MarshallableIn
    
    Provides a DocumentContext that can be used to read data from a source. The specific source and the means of reading are determined by the concrete implementation.
    
    Returns:
    
    A DocumentContext appropriate for reading from the underlying source.
  - initReadContext
```
protected void initReadContext()
```
    Initializes the reading context. This method ensures that the binary document context is used if none is already set and prepares the YamlTokeniser for reading from the current position.
  - useBinaryDocuments
```
@NotNull
public @NotNull YamlWire useBinaryDocuments()
```
    Configures the YamlWire to use binary format for document reading and writing. This involves setting up contexts that handle the binary format of documents.
    
    Returns:
    
    The current instance of YamlWire.
  - useTextDocuments
```
@NotNull
public @NotNull YamlWire useTextDocuments()
```
    Configures the YamlWire to use text format for document reading and writing. This involves setting up contexts that handle the text format of documents.
    
    Returns:
    
    The current instance of YamlWire.
  - readingDocument
```
@NotNull
public @NotNull DocumentContext readingDocument(long readLocation)
```
    Description copied from interface: WireIn
    
    Provides a context for reading a document starting at a specific position.
    
    Parameters:
    
    readLocation - The position from which to start reading the document.
    
    Returns:
    
    the document context associated with the specific read location.
  - createValueIn
```
@NotNull
protected @NotNull net.openhft.chronicle.wire.YamlWire.TextValueIn createValueIn()
```
    Creates a new instance of TextValueIn. This method can be overridden by subclasses to provide a custom implementation of TextValueIn.
    
    Returns:
    
    A new instance of TextValueIn.
  - toString
```
public String toString()
```
    Converts the current YamlWire instance into a string representation. If the bytes to be read exceed 1MB, a truncated version of the bytes (limited to the first 1MB) is returned, followed by "..". Otherwise, it returns the full string representation of the bytes.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The string representation of the YamlWire instance.
  - copyTo
```
public void copyTo(@NotNull
                   @NotNull WireOut wire)
            throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Description copied from interface: WireIn
    
    Copies the content from the current WireIn source to the provided WireOut destination.
    
    Parameters:
    
    wire - The WireOut instance where the content will be copied to.
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an error in the marshalling process.
  - readEventNumber
```
public long readEventNumber()
```
    Description copied from interface: WireIn
    
    Reads the next event number. If no number is present, returns Long.MIN_VALUE.
    
    Specified by:
    
    readEventNumber in interface WireIn
    
    Overrides:
    
    readEventNumber in class AbstractWire
    
    Returns:
    
    The next event number or Long.MIN_VALUE if no number is present.
  - read
```
@NotNull
public @NotNull ValueIn read()
```
    Description copied from interface: WireIn
    
    Reads the next field if present, or returns an empty string if not present.
    
    Returns:
    
    The value of the next field, encapsulated in a ValueIn instance.
  - readField
```
@NotNull
protected @NotNull StringBuilder readField(@NotNull
                                                    @NotNull StringBuilder sb)
```
    Reads a field from the current YamlToken and appends its content to the provided StringBuilder.
    
    Parameters:
    
    sb - StringBuilder instance to which the field content will be appended.
    
    Returns:
    
    The same StringBuilder instance with the appended content.
  - readEvent
```
@Nullable
public <K> K readEvent(@NotNull
                                 @NotNull Class<K> expectedClass)
                          throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Description copied from interface: WireIn
    
    Reads a field which may contain an object of any specified type.
    
    Type Parameters:
    
    K - The type of object expected.
    
    Parameters:
    
    expectedClass - The class type hint of the expected object. If no hint is available, use Object.class.
    
    Returns:
    
    An instance of the specified expectedClass.
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an error in the marshalling process.
  - 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()
```
    Description copied from interface: WireIn
    
    Consumes and discards any padding that may exist between the current read position and the next piece of meaningful data.
  - readingPeekYaml
```
@NotNull
public @NotNull String readingPeekYaml()
```
    Description copied from interface: WireIn
    
    Peeks at the content in the current WireIn instance and returns it as a YAML string.
    
    Returns:
    
    A String containing a YAML representation of the peeked content.
  - read
```
@NotNull
public @NotNull ValueIn read(@NotNull
                                      @NotNull WireKey key)
```
    Description copied from interface: WireIn
    
    Reads the next field if present. The field should match the provided WireKey.
    
    Parameters:
    
    key - The WireKey that should match the next field.
    
    Returns:
    
    The value of the matched field, encapsulated in a ValueIn instance.
  - read
```
@NotNull
public @NotNull ValueIn read(String keyName)
```
    Description copied from interface: WireIn
    
    Reads the next field based on the provided field name.
    
    Parameters:
    
    keyName - The name of the field to read.
    
    Returns:
    
    The value of the specified field, encapsulated in a ValueIn instance.
  - dumpContext
```
public String dumpContext()
```
    Produces a dump of the current parsing context. Useful for debugging.
    
    Returns:
    
    A string representation of the current parsing context.
  - read
```
@NotNull
public @NotNull ValueIn read(@NotNull
                                      @NotNull StringBuilder name)
```
    Description copied from interface: WireIn
    
    Reads a specific field based on the provided field name. If the field is not present, it returns an empty string.
    
    Parameters:
    
    name - The name of the field to read.
    
    Returns:
    
    The value of the specified field, encapsulated in a ValueIn instance.
  - getValueIn
```
@NotNull
public @NotNull ValueIn getValueIn()
```
    Description copied from interface: WireIn
    
    Obtains the value associated with a field or event for more advanced use cases. Typically used after a call to WireIn.readEvent(Class).
    
    Returns:
    
    The value of the field or event, encapsulated in a ValueIn instance.
  - readComment
```
@NotNull
public @NotNull Wire readComment(@NotNull
                                          @NotNull StringBuilder s)
```
    Description copied from interface: WireIn
    
    Reads a comment from the Wire data and appends it to the provided StringBuilder.
    
    Parameters:
    
    s - StringBuilder to which the comment will be appended.
    
    Returns:
    
    the WireIn instance for method chaining.
  - clear
```
public void clear()
```
    Description copied from interface: WireIn
    
    Clears the WireIn, effectively resetting its state.
    
    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()
```
    Consumes and skips the start of a YAML document, e.g., '---'. For specific keywords (like "!!data" and "!!meta-data"), the cursor position remains unchanged.
  - 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()
```
    Description copied from interface: WireIn
    
    Marks the start of an event or method flow.
  - isEndEvent
```
public boolean isEndEvent()
```
    Description copied from interface: WireIn
    
    Checks if the current position in the stream represents the end of an event or method flow.
    
    Returns:
    
    true if the current position is the end of an event, otherwise false.
  - endEvent
```
public void endEvent()
```
    Description copied from interface: WireIn
    
    Marks the end of an event or method flow.
  - reset
```
public void reset()
```
    Resets the state of the YamlWire instance, clearing all buffers and contexts.
  - hasMetaDataPrefix
```
public boolean hasMetaDataPrefix()
```
    Description copied from interface: WireIn
    
    Checks if the current position in the stream has a metadata prefix.
    
    Returns:
    
    true if there's a metadata prefix at the current position, otherwise false.
  - readDocument
```
public boolean readDocument(@Nullable
                            @Nullable ReadMarshallable metaDataConsumer,
                            @Nullable
                            @Nullable ReadMarshallable dataConsumer)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Description copied from interface: WireIn
    
    Reads a document, consuming both its metadata and data sections.
    
    Parameters:
    
    metaDataConsumer - Consumer that processes the metadata section of the document.
    
    dataConsumer - Consumer that processes the main data section of the document.
    
    Returns:
    
    true if the document was successfully read, otherwise false.
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error during marshalling.
  - readDocument
```
public boolean readDocument(long position,
                            @Nullable
                            @Nullable ReadMarshallable metaDataConsumer,
                            @Nullable
                            @Nullable ReadMarshallable dataConsumer)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Description copied from interface: WireIn
    
    Reads a document from a specific position, consuming both its metadata and data sections.
    
    Parameters:
    
    position - The position from which to start reading the document.
    
    metaDataConsumer - Consumer that processes the metadata section of the document.
    
    dataConsumer - Consumer that processes the main data section of the document.
    
    Returns:
    
    true if the document was successfully read from the given position, otherwise false.
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error during marshalling.
  - writingIsComplete
```
public boolean writingIsComplete()
```
    Description copied from interface: RollbackIfNotCompleteNotifier
    
    Checks if the current writing operation is complete. This method can be used to determine if it's safe to proceed with further operations or if a rollback is required.
    
    Returns:
    
    true if the current operation is complete, false otherwise
  - rollbackIfNotComplete
```
public void rollbackIfNotComplete()
```
    Description copied from interface: RollbackIfNotCompleteNotifier
    
    Rolls back the current operation if it is not complete. This method should be invoked to ensure data consistency and to prevent partial updates. Implementations may throw an UnsupportedOperationException if rollback is not supported.

Class YamlWire

Nested Class Summary

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

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

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

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

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

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

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

Constructor Detail

YamlWire

YamlWire

Method Detail

fromFile

from

asText

isBinary

hintReadInputOrder

methodWriter

methodWriterBuilder

methodReaderBuilder

writingDocument

acquireWritingDocument

readingDocument

initReadContext

useBinaryDocuments

useTextDocuments

readingDocument

createValueIn

toString

copyTo

readEventNumber

read

readField

readEvent

isNotEmptyAfterPadding

consumePadding

readingPeekYaml

read

read

dumpContext

read

getValueIn

readComment

clear

consumeDocumentStart

newLongReference

newBooleanReference

useSelfDescribingMessage

newIntReference

newLongArrayReference

newIntArrayReference

startEvent

isEndEvent

endEvent

reset

hasMetaDataPrefix

readDocument

readDocument

writingIsComplete

rollbackIfNotComplete