net.openhft.chronicle.wire

Interface ReadDocumentContext

All Superinterfaces:

AutoCloseable, Closeable, DocumentContext, SourceContext

All Known Implementing Classes:

BinaryReadDocumentContext, TextReadDocumentContext

public interface ReadDocumentContext
extends DocumentContext

Represents a context for reading documents. This interface extends DocumentContext and provides methods to manipulate the reading limits and positions within a document.

Field Summary

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

NOOP

Method Summary

Modifier and Type	Method and Description
void	closeReadLimit(long readLimit) Sets the read limit for this ReadDocumentContext.
void	closeReadPosition(long readPosition) Sets the read position for this ReadDocumentContext.
void	start() Initiates the start of reading within the context.

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

Initiates the start of reading within the context.

closeReadLimit

void closeReadLimit(long readLimit)

Sets the read limit for this ReadDocumentContext. This defines the boundary or endpoint within the document up to which reading should occur.

Parameters:

readLimit - The long value representing the read limit.

closeReadPosition

void closeReadPosition(long readPosition)

Sets the read position for this ReadDocumentContext. This defines the starting point within the document from which reading should begin.

Parameters:

readPosition - The long value representing the read position.