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

Method Summary

Modifier and Type	Method and Description
void	close()
default boolean	isData()
boolean	isMetaData()
boolean	isNotComplete()
default boolean	isOpen()
boolean	isPresent()
void	metaData(boolean metaData) Deprecated.
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()

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

index, sourceId

Method Detail

isMetaData

boolean isMetaData()

Returns:

true - is the entry is of type meta data

metaData

@Deprecated
void metaData(boolean metaData)

Deprecated.

Set the metaData flag. When writing this will determine whether the message is written as metaData or not.

Parameters:

metaData - write as metaData instead of data if true.

isPresent

boolean isPresent()

Returns:

true - if is a document document

isData

default boolean isData()

Returns:

true - is the entry is of type data

wire

@Nullable
@Nullable Wire wire()

Returns:

the wire of 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