net.openhft.chronicle.wire

Interface WriteDocumentContext

All Superinterfaces:

AutoCloseable, Closeable, DocumentContext, SourceContext

All Known Implementing Classes:

BinaryWriteDocumentContext, DocumentContextHolder, TextWriteDocumentContext

public interface WriteDocumentContext
extends DocumentContext

This is the WriteDocumentContext interface extending DocumentContext. It defines methods related to the writing context of a document. The interface offers features to determine metadata status, check if elements are chained, and discern if the document context is empty or not.

Field Summary

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

NOOP

Method Summary

Modifier and Type	Method and Description
boolean	chainedElement() Returns true if this WriteDocumentContext is a chained element.
void	chainedElement(boolean chainedElement) Marks this WriteDocumentContext as a chained element.
boolean	isEmpty() Checks if the writing context is empty.
void	start(boolean metaData) Initializes the writing context with a specific metadata status.

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

close, isData, isMetaData, isNotComplete, isOpen, isPresent, reset, rollbackIfNotComplete, rollbackOnClose, wire

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

index, sourceId

Method Detail

start

void start(boolean metaData)

Initializes the writing context with a specific metadata status.

Parameters:

metaData - A boolean value indicating if the context is metadata.

chainedElement

boolean chainedElement()

Returns true if this WriteDocumentContext is a chained element.

Returns:

true if this WriteDocumentContext is a chained element; otherwise, false.

chainedElement

void chainedElement(boolean chainedElement)

Marks this WriteDocumentContext as a chained element.

Parameters:

chainedElement - A boolean value indicating if the context is a chained element.

isEmpty

boolean isEmpty()

Checks if the writing context is empty.

Returns:

true if the context is empty; otherwise, false.