net.openhft.chronicle.wire

Interface DocumentContext

All Superinterfaces:

AutoCloseable, Closeable, SourceContext

All Known Subinterfaces:

ReadDocumentContext, WriteDocumentContext

All Known Implementing Classes:

BinaryReadDocumentContext, BinaryWriteDocumentContext, DocumentContextHolder, NoDocumentContext, TextReadDocumentContext, TextWriteDocumentContext, WrappedDocumentContext

public interface DocumentContext
extends Closeable, SourceContext

Represents a context that governs the interactions and state management for a document. It provides methods to interrogate and manipulate the state of the associated document, ensuring consistent and safe operations. This interface offers checks for metadata, presence, and completion status of the document, as well as operations to manage the context's lifecycle such as open, close, and reset.

Implementations must ensure proper handling of resources and consistency of the document state.

Field Summary

Fields

Modifier and Type	Field and Description
static DocumentContext	NOOP

Method Summary

Modifier and Type	Method and Description
void	close() Closes the DocumentContext and releases any held resources.
default boolean	isData() Determines if the DocumentContext is in an open state.
boolean	isMetaData() Checks it the DocumentContext is metadata.
boolean	isNotComplete()
default boolean	isOpen()
boolean	isPresent() Checks if the DocumentContext is present.
void	reset() Cleans up the DocumentContext by invoking the close method, then discarding any lingering state associated with it.
default void	rollbackIfNotComplete() Call this if any incomplete message should be rolled back at this point, it it wasn't complete by now.
default void	rollbackOnClose() Invoked to signal an error condition in the current context.
@Nullable Wire	wire() Returns the Wire associated with the Document.

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

index, sourceId

Field Detail

NOOP

static final DocumentContext NOOP

Method Detail

isMetaData

boolean isMetaData()

Checks it the DocumentContext is metadata. If it is, true is returned, otherwise false.

Returns:

true if the entry is metadata

isPresent

boolean isPresent()

Checks if the DocumentContext is present. If it is, true is returned, otherwise false.

Returns:

true if the entry is present

isData

default boolean isData()

Determines if the DocumentContext is in an open state. This method essentially checks the inverse of the completion status of the context.

Returns:

true if the context is open (i.e., the NOT_COMPLETE flag is set), false otherwise.

wire

@Nullable
@Nullable Wire wire()

Returns the Wire associated with the Document. It is possible that null is returned, depending on the implementation.

Returns:

the Wire associated with the Document.

isNotComplete

boolean isNotComplete()

Returns:

whether the NOT_COMPLETE flag has been set.

isOpen

default boolean isOpen()

rollbackOnClose

default void rollbackOnClose()

Invoked to signal an error condition in the current context. This ensures that upon closing the context, any changes made during its lifecycle are rolled back rather than committing a potentially erroneous state.

rollbackIfNotComplete

default void rollbackIfNotComplete()

Call this if any incomplete message should be rolled back at this point, it it wasn't complete by now.

close

void close()

Closes the DocumentContext and releases any held resources. It is crucial to ensure that this method is invoked after the context's operations are completed to prevent any potential resource leaks or data corruption.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

reset

void reset()

Cleans up the DocumentContext by invoking the close method, then discarding any lingering state associated with it. This provides a way to ensure the context is in a fresh state and free of any residual data or settings.