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

Field Summary

Fields

Modifier and Type	Field and Description
static DocumentContext	NOOP

Method Summary

Modifier and Type	Method and Description
void	close()
default boolean	isData() Checks if the DocumentContext is data.
boolean	isMetaData() Checks it the DocumentContext is metadata.
boolean	isNotComplete()
default boolean	isOpen()
boolean	isPresent() Checks if the DocumentContext is present.
void	reset() call close once, then discard any remaining state
default void	rollbackOnClose() Call this if you have detected an error condition and you want the context rolled back when it is closed, rather than half a message committed
@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()

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

Returns:

true - is the entry is data

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()

Call this if you have detected an error condition and you want the context rolled back when it is closed, rather than half a message committed

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

reset

void reset()

call close once, then discard any remaining state