Uses of Interface
net.openhft.chronicle.wire.DocumentContext

Packages that use DocumentContext

Package	Description
net.openhft.chronicle.wire

Uses of DocumentContext in net.openhft.chronicle.wire

Subinterfaces of DocumentContext in net.openhft.chronicle.wire

Modifier and Type	Interface and Description
interface	ReadDocumentContext Represents a context for reading documents.
interface	WriteDocumentContext This is the WriteDocumentContext interface extending DocumentContext.

Classes in net.openhft.chronicle.wire that implement DocumentContext

Modifier and Type	Class and Description
class	BinaryReadDocumentContext This is the BinaryReadDocumentContext class which implements the ReadDocumentContext interface.
class	BinaryWriteDocumentContext A context used for writing documents in a binary format.
class	DocumentContextHolder This is the DocumentContextHolder class which implements both DocumentContext and WriteDocumentContext.
class	NoDocumentContext An enumeration implementation of the DocumentContext interface.
class	TextReadDocumentContext This class represents the context for reading a document in textual format.
class	TextWriteDocumentContext Provides a concrete implementation of the WriteDocumentContext for text-based wire representations.
class	WrappedDocumentContext This is the WrappedDocumentContext class which implements the DocumentContext interface.

Fields in net.openhft.chronicle.wire declared as DocumentContext

Modifier and Type	Field and Description
static DocumentContext	DocumentContext.NOOP

Methods in net.openhft.chronicle.wire that return DocumentContext

Modifier and Type	Method and Description
static DocumentContext	GenerateMethodWriter.acquireDocumentContext(boolean metaData, ThreadLocal<DocumentContextHolder> documentContextTL, MarshallableOut out) Acquires a DocumentContext instance, either by reusing the existing one from the thread-local context holder if it's not closed or by creating a new one using the provided output.
DocumentContext	DocumentWritten.acquireWritingDocument(boolean metaData) Obtains a DocumentContext for writing.
DocumentContext	MarshallableOut.acquireWritingDocument(boolean metaData) Start or reuse an existing a DocumentContext, optionally call close() when done.
DocumentContext	BinaryWire.acquireWritingDocument(boolean metaData)
DocumentContext	RawWire.acquireWritingDocument(boolean metaData)
DocumentContext	TextWire.acquireWritingDocument(boolean metaData)
DocumentContext	YamlWire.acquireWritingDocument(boolean metaData)
DocumentContext	WireOut.acquireWritingDocument(boolean metaData) Retrieves a context for writing either data or metadata, reusing an existing context if available.
DocumentContext	AbstractAnyWire.acquireWritingDocument(boolean metaData)
DocumentContext	HashWire.acquireWritingDocument(boolean metaData)
DocumentContext	WrappedDocumentContext.dc() Getter method to retrieve the wrapped DocumentContext instance.
DocumentContext	DocumentContextHolder.documentContext() Retrieves the encapsulated DocumentContext instance.
@NotNull DocumentContext	MarshallableIn.readingDocument() Provides a DocumentContext that can be used to read data from a source.
@NotNull DocumentContext	BinaryWire.readingDocument()
@NotNull DocumentContext	RawWire.readingDocument()
@NotNull DocumentContext	WireIn.readingDocument() equivalent to WireIn.readDocument(net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.wire.ReadMarshallable) but with out the use of a lambda expression
@NotNull DocumentContext	TextWire.readingDocument()
@NotNull DocumentContext	YamlWire.readingDocument()
@NotNull DocumentContext	AbstractAnyWire.readingDocument()
@NotNull DocumentContext	BinaryWire.readingDocument(long readLocation)
@NotNull DocumentContext	RawWire.readingDocument(long readLocation)
DocumentContext	WireIn.readingDocument(long readLocation) Provides a context for reading a document starting at a specific position.
@NotNull DocumentContext	TextWire.readingDocument(long readLocation)
@NotNull DocumentContext	YamlWire.readingDocument(long readLocation)
DocumentContext	AbstractAnyWire.readingDocument(long readLocation)
DocumentContext	DocumentWritten.writingDocument() Creates a new DocumentContext for writing a document.
default @NotNull DocumentContext	MarshallableOut.writingDocument() Start a document which is completed when DocumentContext.close() is called.
default @NotNull DocumentContext	WireOut.writingDocument() Starts the process of writing a data document (not metadata) to the wire.
DocumentContext	DocumentWritten.writingDocument(boolean metaData) Initiates a new DocumentContext for writing, with an option to include metadata.
DocumentContext	MarshallableOut.writingDocument(boolean metaData) Begins a new document-writing session with the option to include meta-data.
@NotNull DocumentContext	BinaryWire.writingDocument(boolean metaData)
@NotNull DocumentContext	RawWire.writingDocument(boolean metaData)
@NotNull DocumentContext	TextWire.writingDocument(boolean metaData)
@NotNull DocumentContext	YamlWire.writingDocument(boolean metaData)
DocumentContext	WireOut.writingDocument(boolean metaData) Starts the process of writing a document to the wire with an option for metadata.
DocumentContext	AbstractAnyWire.writingDocument(boolean metaData)
@NotNull DocumentContext	HashWire.writingDocument(boolean metaData)

Methods in net.openhft.chronicle.wire with parameters of type DocumentContext

Modifier and Type	Method and Description
WrappedDocumentContext	WrappedDocumentContext.dc(DocumentContext dc) Setter method to update the wrapped DocumentContext instance.
void	DocumentContextHolder.documentContext(DocumentContext dc) Sets the encapsulated DocumentContext instance to the provided value.
void	VanillaMessageHistory.doWriteHistory(DocumentContext dc)
default void	MessageHistory.doWriteHistory(DocumentContext dc)
static String	Wires.fromSizePrefixedBlobs(@NotNull DocumentContext dc) Converts the contents of the provided DocumentContext which represent size-prefixed blobs into a readable string format.
MethodReaderStatus	AbstractGeneratedMethodReader.readOne0(DocumentContext context) Reads the content based on the provided document context.
static void	MessageHistory.writeHistory(DocumentContext dc)

Constructors in net.openhft.chronicle.wire with parameters of type DocumentContext

Constructor and Description
WrappedDocumentContext(DocumentContext dc) Constructs a new instance of WrappedDocumentContext that wraps the provided DocumentContext.