| Package | Description |
|---|---|
| net.openhft.chronicle.wire | |
| net.openhft.chronicle.wire.domestic.extractor | |
| net.openhft.chronicle.wire.domestic.reduction |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractAnyWire
An abstract representation of a wire type that could be either
TextWire or BinaryWire. |
class |
AbstractWire
Represents the AbstractWire class which serves as a base for all Wire implementations.
|
class |
BinaryWire
Primary implementation of the binary wire format.
|
class |
CSVWire
Text based wire format for Comma Separated Values (CSV).
|
class |
JSONWire
Represents the JSON wire format for text-based marshalling and parsing.
|
class |
QueryWire
Parses a URL query string such as
"a=1&b=2". |
class |
RawWire
Wire implementation that serialises values in sequence without any field names.
|
class |
ReadAnyWire
Represents a wire type that can be either
TextWire or BinaryWire. |
class |
TextWire
A representation of the YAML-based wire format.
|
class |
YamlWire
Represents a YAML-based wire format designed for efficient parsing and serialization of data.
|
class |
YamlWireOut<T extends YamlWireOut<T>>
Provides functionality for writing data in a YAML-based wire format.
|
| Modifier and Type | Field and Description |
|---|---|
protected Wire |
TextWriteDocumentContext.wire |
protected @Nullable Wire |
TextReadDocumentContext.wire |
protected @Nullable Wire |
BinaryReadDocumentContext.wire |
protected Wire |
BinaryWriteDocumentContext.wire |
| Modifier and Type | Method and Description |
|---|---|
default Wire |
Wire.generateTuples(boolean generateTuples)
Sets whether tuples should be generated.
|
Wire |
AbstractWire.generateTuples(boolean generateTuples) |
Wire |
WireToOutputStream.getWire()
Returns the internal
Wire prepared for a new message. |
@NotNull Wire |
Wire.headerNumber(long headerNumber)
Set the header number for the Wire.
|
@NotNull Wire |
AbstractWire.headerNumber(long headerNumber) |
static Wire |
Wire.newYamlWireOnHeap()
Factory method to create a new YamlWire instance that writes to an on-heap Bytes object.
|
@NotNull Wire |
BinaryWire.readComment(@NotNull StringBuilder s)
|
@NotNull Wire |
RawWire.readComment(@NotNull StringBuilder sb) |
@NotNull Wire |
CSVWire.readComment(@NotNull StringBuilder s)
Clears
s as inline comments are not expected in CSV. |
@NotNull Wire |
TextWire.readComment(@NotNull StringBuilder s) |
@NotNull Wire |
YamlWire.readComment(@NotNull StringBuilder s) |
Wire |
InputStreamToWire.readOne()
Reads the next length-prefixed message from the input stream and makes
it available through the internal
Wire instance. |
@Nullable Wire |
AbstractAnyWire.underlyingWire()
Retrieves the underlying wire, which could be either
TextWire or BinaryWire,
based on the acquisition strategy. |
Wire |
TextWriteDocumentContext.wire() |
@Nullable Wire |
TextReadDocumentContext.wire() |
@Nullable Wire |
BinaryReadDocumentContext.wire() |
@Nullable Wire |
DocumentContext.wire()
Returns the
Wire associated with the Document. |
@Nullable Wire |
WrappedDocumentContext.wire() |
Wire |
NoDocumentContext.wire() |
@Nullable Wire |
DocumentContextHolder.wire() |
Wire |
BinaryWriteDocumentContext.wire() |
@NotNull Wire |
BinaryWire.writeComment(CharSequence s) |
@NotNull Wire |
RawWire.writeComment(CharSequence s) |
| Modifier and Type | Method and Description |
|---|---|
static net.openhft.chronicle.core.scoped.ScopedResource<Wire> |
Wires.acquireBinaryWireScoped()
Obtains a pooled
BinaryWire wrapped in a ScopedResource
for temporary serialisation tasks. |
| Modifier and Type | Method and Description |
|---|---|
static String |
TextWire.asText(@NotNull Wire wire)
Converts any wire format into a text representation.
|
static String |
JSONWire.asText(@NotNull Wire wire)
Converts the content of the provided wire to a JSON string.
|
static String |
YamlWire.asText(@NotNull Wire wire)
Converts the content of a given
Wire object into its string representation. |
protected void |
AbstractMethodWriterInvocationHandler.handleInvoke(@NotNull Method method,
Object[] args,
Wire wire)
Handles the method invocation, writes the event details to the provided wire,
and supports optional recording of method history.
|
void |
ExcerptListener.onExcerpt(@NotNull Wire wire,
long index)
Invoked per each encountered excerpt.
|
static @Nullable WireType |
WireType.valueOf(@Nullable Wire wire)
Determines the
WireType of a given Wire. |
| Constructor and Description |
|---|
BinaryReadDocumentContext(@Nullable Wire wire)
Constructor that initializes the BinaryReadDocumentContext using the provided wire.
|
BinaryReadDocumentContext(@Nullable Wire wire,
boolean ensureFullRead)
Deprecated.
|
BinaryWriteDocumentContext(Wire wire)
Constructs a new context for writing binary documents using the specified wire.
|
LongArrayValueBitSet(long maxNumberOfBits,
Wire w)
Create a bit set of
maxNumberOfBits bits and immediately marshal its state
to and from the provided Wire. |
LongValueBitSet(int maxNumberOfBits,
Wire w)
Creates a bit set sized for
maxNumberOfBits bits and immediately
binds the backing array to the supplied Wire for serialisation. |
LongValueBitSet(long maxNumberOfBits,
Wire w)
Creates a bit set sized for
maxNumberOfBits bits and binds its
storage to a Wire for marshalling. |
TextReadDocumentContext(@Nullable Wire wire)
Constructor for the TextReadDocumentContext.
|
TextWriteDocumentContext(Wire wire)
Constructs a new context for the specified wire.
|
| Modifier and Type | Method and Description |
|---|---|
T |
DocumentExtractor.extract(@NotNull Wire wire,
long index)
Extracts a value of type T from the provided
wire and index or else null
if no value can be extracted. |
double |
ToDoubleDocumentExtractor.extractAsDouble(@NotNull Wire wire,
long index)
Extracts a value of type
double from the provided wire and index or else Double.NaN
if no value can be extracted. |
long |
ToLongDocumentExtractor.extractAsLong(@NotNull Wire wire,
long index)
Extracts a value of type
long from the provided wire and index or else Long.MIN_VALUE
if no value can be extracted. |
| Modifier and Type | Method and Description |
|---|---|
void |
Reduction.onExcerpt(@NotNull Wire wire,
long index)
Consumes an excerpt from the provided
wire at the index at the provided index. |
void |
Reductions.Counting.onExcerpt(@NotNull Wire wire,
long index) |
Copyright © 2026 Chronicle Software Ltd. All rights reserved.