TextWire (OpenHFT/Chronicle-Wire 2026.6 API)

java.lang.Object
- net.openhft.chronicle.wire.AbstractWire
- - net.openhft.chronicle.wire.YamlWireOut<TextWire>
  - - net.openhft.chronicle.wire.TextWire

All Implemented Interfaces:

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

Direct Known Subclasses:

CSVWire, JSONWire, QueryWire
```
public class TextWire
extends YamlWireOut<TextWire>
```
A representation of the YAML-based wire format. `TextWire` provides functionalities for reading and writing objects in a YAML-based format, and encapsulates various characteristics of the YAML text format.
This class utilizes bit sets, thread locals, and regular expressions to efficiently handle the YAML formatting nuances.
Important: Some configurations and methods in this class are marked as deprecated and are slated for removal in future versions, suggesting that its behavior might evolve in future releases.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class TextWire.TextValueIn
Represents a textual input value for deserialization.
- 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

Nested Classes
Modifier and Type	Class and Description
`class`	`TextWire.TextValueIn` Represents a textual input value for deserialization.

Field Summary

Fields
Modifier and Type	Field and Description
`static net.openhft.chronicle.bytes.BytesStore<?,?>`	`BINARY`
`protected long`	`lineStart` Represents the start of the current line being processed in the wire format.
`protected ReadDocumentContext`	`readContext` Context for reading documents from the wire format.
`static @NotNull net.openhft.chronicle.bytes.Bytes<byte[]>`	`TYPE_STR`
`protected TextWire.TextValueIn`	`valueIn` Input value parser specifically for text-based wire format.
`protected WriteDocumentContext`	`writeContext` Context for writing documents in the wire format.

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
`TextWire()` Default constructor initializing the `TextWire` with elastic on-heap bytes, assume text documents.
`TextWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)` Constructor that initializes the `TextWire` with bytes representation with default 8-bit encoding turned off.
`TextWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean use8bit)` Constructor to initialize the `TextWire` with a specific bytes representation and a flag to determine if 8-bit encoding is to be used.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DocumentContext`	`acquireWritingDocument(boolean metaData)` Obtains a `DocumentContext` for writing.
`static String`	`asText(@NotNull Wire wire)` Converts any wire format into a text representation.
`net.openhft.chronicle.core.pool.ClassLookup`	`classLookup()` Returns the current `ClassLookup` implementation being used for class lookup.
`void`	`classLookup(net.openhft.chronicle.core.pool.ClassLookup classLookup)` Sets the `ClassLookup` implementation to be used for class lookup.
`void`	`clear()` Clears the WireIn, effectively resetting its state.
`protected void`	`consumeDocumentStart()` Consumes the start of a document in the byte stream.
`void`	`consumePadding()` Consumes and discards any padding that may exist between the current read position and the next piece of meaningful data.
`void`	`consumePadding(int commas)` Consumes padding characters from the current reading position.
`void`	`consumeWhiteSpace()` Consumes and skips over white space characters from the current position in the byte stream.
`void`	`copyTo(@NotNull WireOut wire)` Copies the content from the current WireIn source to the provided WireOut destination.
`protected @NotNull TextWire.TextValueIn`	`createValueIn()` Creates and returns a new instance of TextValueIn.
`protected Class<?>`	`defaultKeyClass()` Returns the default class to be used as a key.
`static @NotNull TextWire`	`from(@NotNull String text)` Factory method to create a `TextWire` from a string representation.
`static @NotNull TextWire`	`fromFile(String filePath)` Factory method to create a `TextWire` from a file.
`protected @NotNull net.openhft.chronicle.bytes.StopCharsTester`	`getEscapingEndEventName()`
`protected @NotNull net.openhft.chronicle.bytes.StopCharTester`	`getEscapingEndOfText()` Retrieves the StopCharTester that determines the end of text with escaping.
`protected @Nullable net.openhft.chronicle.bytes.StopCharTester`	`getEscapingQuotes()` Retrieves the StopCharTester that determines the end of a quoted text section with escaping.
`protected @NotNull net.openhft.chronicle.bytes.StopCharsTester`	`getStrictEscapingEndOfText()` Retrieves the StopCharsTester that determines the end of text with strict escaping.
`@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.
`protected void`	`initReadContext()` Initializes the read context for this TextWire instance.
`boolean`	`isBinary()` Determine whether direct access to the underlying byte() makes sense or should it be treated as text
`static <T> T`	`load(String filename)` Loads an Object from a file
`@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`.
`void`	`parseUntil(@NotNull StringBuilder sb, @NotNull net.openhft.chronicle.bytes.StopCharsTester stopTester)` Clears the StringBuilder and then parses characters from the current byte position until one of the specified stop characters in the tester is encountered.
`void`	`parseUntil(@NotNull StringBuilder sb, @NotNull net.openhft.chronicle.bytes.StopCharTester stopTester)` Parses characters from the current byte position until one of the specified stop characters in the tester is encountered.
`void`	`parseWord(@NotNull StringBuilder sb)` Parses a word from the current byte position until it encounters a space or stop character.
`protected boolean`	`peekStringIgnoreCase(@NotNull String source)` returns `true` if the next string is `str`
`@NotNull ValueIn`	`read()` Reads the next field if present, or returns an empty string if not present.
`@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.
`protected ValueIn`	`read2(CharSequence keyName, int keyCode, Object defaultValue, @NotNull net.openhft.chronicle.wire.ValueInState currentState, @NotNull StringBuilder tempNameBuilder, @NotNull CharSequence name)` Deprecated.
`protected ValueIn`	`read2(Object defaultValue, @NotNull net.openhft.chronicle.wire.ValueInState currentState, @NotNull StringBuilder tempNameBuilder, @NotNull CharSequence name)` Attempts to read the value, continuing the read operation from the primary `read` method.
`protected int`	`readCode()` Reads the next byte as an unsigned integer.
`@NotNull Wire`	`readComment(@NotNull StringBuilder s)` Reads a comment from the Wire data and appends it to the provided StringBuilder.
`<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 the field from the current position of the wire and appends it to the given 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.
`@Nullable Object`	`readObject()` Reads and returns an object from the current position in the bytes stream.
`void`	`reset()` Reset the state of the wire
`void`	`rollbackIfNotComplete()` Rolls back the current operation if it is not complete.
`boolean`	`strict()` Retrieves the current strict mode setting for this TextWire instance.
`TextWire`	`strict(boolean strict)` Sets the strict mode for this TextWire instance.
`String`	`to8bitString()` Converts the underlying bytes of this TextWire to its ISO-8859-1 string representation.
`String`	`toString()` Converts the underlying bytes of this TextWire to its string representation.
`String`	`toUtf8String()` Converts the underlying bytes of this TextWire to its UTF-8 string representation.
`static <ACS extends Appendable & CharSequence> void`	`unescape(ACS sb)` Processes and unescapes the provided `CharSequence` containing escaped sequences.
`@NotNull TextWire`	`useBinaryDocuments()` Configures this TextWire instance to use binary document contexts for reading and writing.
`boolean`	`useSelfDescribingMessage(@NotNull net.openhft.chronicle.bytes.CommonMarshallable object)` Should this wire write the object as a Marshallable or BytesMarshallable
`@NotNull TextWire`	`useTextDocuments()` Configures this TextWire instance to use textual document contexts for 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, commentListener, endOfWire, enterHeader, forceNotInsideHeader, generateTuples, generateTuples, 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
endEvent, hasMore, hintReadInputOrder, isEmpty, isEndEvent, isNotEmptyAfterPadding, rawReadData, read, readAlignTo, readAllAsMap, readDataHeader, readDocument, readDocument, readEventName, startEvent

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

- Field Detail
  - BINARY
```
public static final net.openhft.chronicle.bytes.BytesStore<?,?> BINARY
```
  - TYPE_STR
```
@NotNull
public static final @NotNull net.openhft.chronicle.bytes.Bytes<byte[]> TYPE_STR
```
  - valueIn
```
protected final TextWire.TextValueIn valueIn
```
    Input value parser specifically for text-based wire format.
  - lineStart
```
protected long lineStart
```
    Represents the start of the current line being processed in the wire format.
  - writeContext
```
protected WriteDocumentContext writeContext
```
    Context for writing documents in the wire format.
  - readContext
```
protected ReadDocumentContext readContext
```
    Context for reading documents from the wire format.
- Constructor Detail
  - TextWire
```
public TextWire()
```
    Default constructor initializing the `TextWire` with elastic on-heap bytes, assume text documents.
  - TextWire
```
public TextWire(@NotNull
                @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                boolean use8bit)
```
    Constructor to initialize the `TextWire` with a specific bytes representation and a flag to determine if 8-bit encoding is to be used.
    
    Parameters:
    
    bytes - Bytes representation.
    
    use8bit - Flag to determine if 8-bit encoding is to be used.
  - TextWire
```
public TextWire(@NotNull
                @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)
```
    Constructor that initializes the `TextWire` with bytes representation with default 8-bit encoding turned off.
    
    Parameters:
    
    bytes - Bytes representation.
- Method Detail
  - fromFile
```
@NotNull
public static @NotNull TextWire fromFile(String filePath)
                                           throws IOException
```
    Factory method to create a `TextWire` from a file.
    
    Parameters:
    
    filePath - Name of the file.
    
    Returns:
    
    A new instance of `TextWire`.
    
    Throws:
    
    IOException - if any I/O error occurs.
  - from
```
@NotNull
public static @NotNull TextWire from(@NotNull
                                              @NotNull String text)
```
    Factory method to create a `TextWire` from a string representation.
    
    Parameters:
    
    text - String representation of the wire format.
    
    Returns:
    
    A new instance of `TextWire`.
  - asText
```
public static String asText(@NotNull
                            @NotNull Wire wire)
```
    Converts any wire format into a text representation.
    
    Parameters:
    
    wire - The wire format to be converted.
    
    Returns:
    
    The text representation of the wire format.
  - unescape
```
public static <ACS extends Appendable & CharSequence> void unescape(@NotNull
                                                                    ACS sb)
```
    Processes and unescapes the provided CharSequence containing escaped sequences. For instance, "\\n" is converted to a newline character, "\\t" to a tab, etc. This method modifies the given sequence directly and adjusts its length if needed.
    
    Parameters:
    
    sb - A CharSequence that is also an Appendable, containing potentially escaped sequences. This sequence will be modified directly.
  - load
```
public static <T> T load(String filename)
                  throws IOException,
                         net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Loads an Object from a file
    
    Type Parameters:
    
    T - the type of the object to load
    
    Parameters:
    
    filename - the file-path containing the object
    
    Returns:
    
    an instance of the object created from the data in the file
    
    Throws:
    
    IOException - if the file can not be found or read
    
    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
  - strict
```
public boolean strict()
```
    Retrieves the current strict mode setting for this TextWire instance.
    
    Returns:
    
    A boolean indicating whether strict mode is enabled (true) or disabled (false).
  - strict
```
public TextWire strict(boolean strict)
```
    Sets the strict mode for this TextWire instance. When strict mode is enabled, the instance may enforce stricter parsing or serialization rules.
    
    Parameters:
    
    strict - A boolean value to set the strict mode. True to enable, false to disable.
    
    Returns:
    
    The current TextWire instance, allowing for method chaining.
  - 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.
  - classLookup
```
public void classLookup(net.openhft.chronicle.core.pool.ClassLookup classLookup)
```
    Description copied from interface: WireCommon
    
    Sets the ClassLookup implementation to be used for class lookup.
    
    Specified by:
    
    classLookup in interface WireCommon
    
    Overrides:
    
    classLookup in class AbstractWire
    
    Parameters:
    
    classLookup - implementation to be used for class lookup.
  - classLookup
```
public net.openhft.chronicle.core.pool.ClassLookup classLookup()
```
    Description copied from interface: WireCommon
    
    Returns the current ClassLookup implementation being used for class lookup.
    
    Specified by:
    
    classLookup in interface WireCommon
    
    Overrides:
    
    classLookup in class AbstractWire
    
    Returns:
    
    the current ClassLookup implementation being used for class lookup
  - 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 read context for this TextWire instance. If the read context is not already set, the default behavior is to use binary documents.
  - useBinaryDocuments
```
@NotNull
public @NotNull TextWire useBinaryDocuments()
```
    Configures this TextWire instance to use binary document contexts for reading and writing. This will replace the current read and write contexts with binary contexts.
    
    Returns:
    
    The current TextWire instance, allowing for method chaining.
  - useTextDocuments
```
@NotNull
public @NotNull TextWire useTextDocuments()
```
    Configures this TextWire instance to use textual document contexts for reading and writing. This will replace the current read and write contexts with textual contexts.
    
    Returns:
    
    The current TextWire instance, allowing for method chaining.
  - 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 TextWire.TextValueIn createValueIn()
```
    Creates and returns a new instance of TextValueIn. This method is primarily intended for internal use to provide consistent access to TextValueIn instances.
    
    Returns:
    
    A new instance of TextValueIn.
  - toString
```
public String toString()
```
    Converts the underlying bytes of this TextWire to its string representation. For large byte sequences, only the initial part of the data is returned followed by "..".
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the TextWire's underlying bytes.
  - to8bitString
```
public String to8bitString()
```
    Converts the underlying bytes of this TextWire to its ISO-8859-1 string representation.
    
    Returns:
    
    A string representation of the TextWire's underlying bytes in ISO-8859-1 encoding.
  - toUtf8String
```
public String toUtf8String()
```
    Converts the underlying bytes of this TextWire to its UTF-8 string representation.
    
    Returns:
    
    A string representation of the TextWire's underlying bytes in UTF-8 encoding.
  - 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 the field from the current position of the wire and appends it to the given StringBuilder. The method handles different encodings and escape sequences, and ensures correct parsing of field data.
    
    Parameters:
    
    sb - The StringBuilder to which the field value should be appended.
    
    Returns:
    
    The updated StringBuilder containing the field value.
  - 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.
  - defaultKeyClass
```
protected Class<?> defaultKeyClass()
```
    Returns the default class to be used as a key. By default, this method returns the Object class.
    
    Returns:
    
    The default key class, which is Object.
  - getEscapingEndOfText
```
@NotNull
protected @NotNull net.openhft.chronicle.bytes.StopCharTester getEscapingEndOfText()
```
    Retrieves the StopCharTester that determines the end of text with escaping. The tester is fetched from a thread-local storage and then reset.
    
    Returns:
    
    The StopCharTester for determining the end of text with escaping.
  - getStrictEscapingEndOfText
```
@NotNull
protected @NotNull net.openhft.chronicle.bytes.StopCharsTester getStrictEscapingEndOfText()
```
    Retrieves the StopCharsTester that determines the end of text with strict escaping. The tester is fetched from thread-local storage and is then reset.
    
    Returns:
    
    The StopCharsTester for determining the end of text with strict escaping.
  - getEscapingEndEventName
```
@NotNull
protected @NotNull net.openhft.chronicle.bytes.StopCharsTester getEscapingEndEventName()
```
  - getEscapingQuotes
```
@Nullable
protected @Nullable net.openhft.chronicle.bytes.StopCharTester getEscapingQuotes()
```
    Retrieves the StopCharTester that determines the end of a quoted text section with escaping. The tester is fetched from thread-local storage and is then reset.
    
    Returns:
    
    The StopCharTester for determining the end of a quoted text section with escaping.
  - 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.
  - consumePadding
```
public void consumePadding(int commas)
```
    Consumes padding characters from the current reading position. Padding characters include spaces, tabs, new lines, commas, and comments. This method also handles skipping over any comments encountered during this process.
    
    Parameters:
    
    commas - The number of comma characters to consume. Once this count is reached, the method will return.
  - consumeDocumentStart
```
protected void consumeDocumentStart()
```
    Consumes the start of a document in the byte stream. The start is determined by the presence of three consecutive '-' characters followed by certain words (e.g., "!!data", "!!meta-data").
  - peekStringIgnoreCase
```
protected boolean peekStringIgnoreCase(@NotNull
                                       @NotNull String source)
```
    returns true if the next string is str
    
    Parameters:
    
    source - string
    
    Returns:
    
    true if the strings are the same
  - readCode
```
protected int readCode()
```
    Reads the next byte as an unsigned integer.
    
    Returns:
    
    The next byte if available or -1 if end-of-file.
  - 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.
  - read2
```
@Deprecated
protected ValueIn read2(CharSequence keyName,
                                    int keyCode,
                                    Object defaultValue,
                                    @NotNull
                                    @NotNull net.openhft.chronicle.wire.ValueInState currentState,
                                    @NotNull
                                    @NotNull StringBuilder tempNameBuilder,
                                    @NotNull
                                    @NotNull CharSequence name)
```
    Deprecated.
    
    Attempts to read the value of a given key, continuing the read operation from the primary `read` method. If the current and old fields do not match the specified key, the default value is returned.
    
    Parameters:
    
    keyName - The name of the key for which the value needs to be read.
    
    keyCode - The code for the key.
    
    defaultValue - The default value to return if the key isn't found.
    
    currentState - The current state of the ValueIn.
    
    tempNameBuilder - The StringBuilder used to capture the field name.
    
    name - The name of the key (same as keyName, possibly added for clarity in some cases).
    
    Returns:
    
    The value associated with the key or the default value if the key is not found.
  - read2
```
protected ValueIn read2(Object defaultValue,
                        @NotNull
                        @NotNull net.openhft.chronicle.wire.ValueInState currentState,
                        @NotNull
                        @NotNull StringBuilder tempNameBuilder,
                        @NotNull
                        @NotNull CharSequence name)
```
    Attempts to read the value, continuing the read operation from the primary `read` method. If the current and old fields do not match the specified key, the default value is returned.
    
    Parameters:
    
    defaultValue - The default value to return if the key isn't found.
    
    currentState - The current state of the ValueIn.
    
    tempNameBuilder - The StringBuilder used to capture the field name.
    
    name - The name of the key (same as keyName, possibly added for clarity in some cases).
    
    Returns:
    
    The value associated with the key or the default value if the key is not found.
  - 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.
  - consumeWhiteSpace
```
public void consumeWhiteSpace()
```
    Consumes and skips over white space characters from the current position in the byte stream.
  - 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
  - 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
  - parseWord
```
public void parseWord(@NotNull
                      @NotNull StringBuilder sb)
```
    Parses a word from the current byte position until it encounters a space or stop character. The parsed word is then appended to the provided StringBuilder.
    
    Parameters:
    
    sb - The StringBuilder to which the parsed word will be appended.
  - parseUntil
```
public void parseUntil(@NotNull
                       @NotNull StringBuilder sb,
                       @NotNull
                       @NotNull net.openhft.chronicle.bytes.StopCharTester stopTester)
```
    Parses characters from the current byte position until one of the specified stop characters in the tester is encountered. The parsed characters are then appended to the provided StringBuilder.
    
    Parameters:
    
    sb - The StringBuilder to which the parsed characters will be appended.
    
    stopTester - A StopCharTester which determines which characters should stop the parsing.
  - parseUntil
```
public void parseUntil(@NotNull
                       @NotNull StringBuilder sb,
                       @NotNull
                       @NotNull net.openhft.chronicle.bytes.StopCharsTester stopTester)
```
    Clears the StringBuilder and then parses characters from the current byte position until one of the specified stop characters in the tester is encountered. The parsed characters are then appended to the provided StringBuilder.
    
    Parameters:
    
    sb - The StringBuilder to which the parsed characters will be appended.
    
    stopTester - A StopCharsTester which determines which characters should stop the parsing.
  - readObject
```
@Nullable
public @Nullable Object readObject()
                                      throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Reads and returns an object from the current position in the bytes stream. Any padding and document start metadata are consumed before attempting to read the object.
    
    Returns:
    
    An instance of the read object, or null if the end of the stream is reached.
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - If the object could not be properly unmarshalled.
  - reset
```
public void reset()
```
    Description copied from interface: WireCommon
    
    Reset the state of the wire
  - 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.
  - writingIsComplete
```
public boolean writingIsComplete()
```
    Description copied from interface: RollbackIfNotCompleteNotifier
    
    Checks if the current writing operation is complete. Returns true by default, indicating completion. Implementations should override this to reflect the actual completion status of their write operation (for example, the inverse of DocumentContext.isNotComplete()).
    
    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. If the current document or operation managed by this notifier is in an incomplete state (for example as indicated by DocumentContext.isNotComplete()), this method should attempt to roll back any changes made within the current context, effectively discarding them. If rollback is not supported or not applicable, an UnsupportedOperationException may be thrown.

Class TextWire

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

Field Detail

BINARY

TYPE_STR

valueIn

lineStart

writeContext

readContext

Constructor Detail

TextWire

TextWire

TextWire

Method Detail

fromFile

from

asText

unescape

load

isBinary

strict

strict

methodWriter

methodWriterBuilder

methodReaderBuilder

classLookup

classLookup

writingDocument

acquireWritingDocument

readingDocument

initReadContext

useBinaryDocuments

useTextDocuments

readingDocument

createValueIn

toString

to8bitString

toUtf8String

copyTo

readEventNumber

read

readField

readEvent

defaultKeyClass

getEscapingEndOfText

getStrictEscapingEndOfText

getEscapingEndEventName

getEscapingQuotes

consumePadding

readingPeekYaml

consumePadding

consumeDocumentStart

peekStringIgnoreCase

readCode

read

read2

read2

read

getValueIn

readComment

consumeWhiteSpace

clear

newLongReference