net.openhft.chronicle.wire

Class BinaryReadDocumentContext

java.lang.Object

net.openhft.chronicle.wire.BinaryReadDocumentContext

All Implemented Interfaces:

Closeable, AutoCloseable, DocumentContext, ReadDocumentContext, SourceContext

public class BinaryReadDocumentContext
extends Object
implements ReadDocumentContext

This is the BinaryReadDocumentContext class which implements the ReadDocumentContext interface. It provides an implementation tailored for reading from binary document contexts and ensures full read capability if required.

Field Summary

Fields

Modifier and Type	Field and Description
long	lastStart
protected boolean	metaData
protected boolean	notComplete
protected boolean	present
protected long	readLimit
protected long	readPosition
protected boolean	rollback
long	start
protected @Nullable AbstractWire	wire

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

NOOP

Constructor Summary

Constructors

Constructor and Description
BinaryReadDocumentContext(@Nullable Wire wire) Constructor that initializes the BinaryReadDocumentContext using the provided wire.
BinaryReadDocumentContext(@Nullable Wire wire, boolean ensureFullRead) Constructor that initializes the BinaryReadDocumentContext using the provided wire and a flag to determine if a full read should be ensured.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the DocumentContext and releases any held resources.
void	closeReadLimit(long readLimit) Sets the read limit for this ReadDocumentContext.
void	closeReadPosition(long readPosition) Sets the read position for this ReadDocumentContext.
long	index() Obtains the index of the last read operation from this source context.
boolean	isMetaData() Checks it the DocumentContext is metadata.
boolean	isNotComplete()
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.
protected boolean	rollback() Determines if a rollback is required for this document context.
protected boolean	rollbackIfNeeded() Rolls back the document context to its state before opening, if the rollback marker is set.
void	rollbackOnClose() Invoked to signal an error condition in the current context.
void	setStart(long start) Sets the start position of the document context and updates the last start position.
int	sourceId() Retrieves the source ID associated with this context.
void	start() Initiates the start of reading within the context.
String	toString()
@Nullable Wire	wire() Returns the Wire associated with the Document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

isData, isOpen, rollbackIfNotComplete

Field Detail

start

public long start

lastStart

public long lastStart

wire

@Nullable
protected @Nullable AbstractWire wire

present

protected boolean present

notComplete

protected boolean notComplete

readPosition

protected long readPosition

readLimit

protected long readLimit

metaData

protected boolean metaData

rollback

protected boolean rollback

Constructor Detail

BinaryReadDocumentContext

public BinaryReadDocumentContext(@Nullable
                                 @Nullable Wire wire)

Constructor that initializes the BinaryReadDocumentContext using the provided wire. It also determines if a full read should be ensured based on the wire type.

Parameters:

wire - The wire used for reading the document.

BinaryReadDocumentContext

public BinaryReadDocumentContext(@Nullable
                                 @Nullable Wire wire,
                                 boolean ensureFullRead)

Constructor that initializes the BinaryReadDocumentContext using the provided wire and a flag to determine if a full read should be ensured.

Parameters:

wire - The wire used for reading the document.

ensureFullRead - Flag to determine if full reading is required.

Method Detail

isMetaData

public boolean isMetaData()

Description copied from interface: DocumentContext

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

Specified by:

isMetaData in interface DocumentContext

Returns:

true if the entry is metadata

isPresent

public boolean isPresent()

Description copied from interface: DocumentContext

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

Specified by:

isPresent in interface DocumentContext

Returns:

true if the entry is present

closeReadPosition

public void closeReadPosition(long readPosition)

Description copied from interface: ReadDocumentContext

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

Specified by:

closeReadPosition in interface ReadDocumentContext

Parameters:

readPosition - The long value representing the read position.

closeReadLimit

public void closeReadLimit(long readLimit)

Description copied from interface: ReadDocumentContext

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

Specified by:

closeReadLimit in interface ReadDocumentContext

Parameters:

readLimit - The long value representing the read limit.

wire

@Nullable
public @Nullable Wire wire()

Description copied from interface: DocumentContext

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

Specified by:

wire in interface DocumentContext

Returns:

the Wire associated with the Document.

rollback

protected boolean rollback()

Determines if a rollback is required for this document context.

Returns:

true if rollback is required, false otherwise.

close

public void close()

Description copied from interface: DocumentContext

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 Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DocumentContext

reset

public void reset()

Description copied from interface: DocumentContext

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.

Specified by:

reset in interface DocumentContext

rollbackIfNeeded

protected boolean rollbackIfNeeded()

Rolls back the document context to its state before opening, if the rollback marker is set. Resets relevant attributes and updates the read position and limit accordingly.

Returns:

true if the context was rolled back, false otherwise.

start

public void start()

Description copied from interface: ReadDocumentContext

Initiates the start of reading within the context.

Specified by:

start in interface ReadDocumentContext

index

public long index()

Description copied from interface: SourceContext

Obtains the index of the last read operation from this source context. This is particularly useful to track the reading progress and can act as a checkpoint or reference point. Note: This method is specifically intended for read contexts and might not be relevant for other context types.

Specified by:

index in interface SourceContext

Returns:

The index corresponding to the last read operation.

sourceId

public int sourceId()

Description copied from interface: SourceContext

Retrieves the source ID associated with this context. A unique identifier that represents the source from which data or operations might be fetched or to which data might be written. If a valid source ID has not been established or isn't available, it defaults to returning -1.

Specified by:

sourceId in interface SourceContext

Returns:

The unique identifier for this source context, or -1 if not available.

isNotComplete

public boolean isNotComplete()

Specified by:

isNotComplete in interface DocumentContext

Returns:

whether the NOT_COMPLETE flag has been set.

rollbackOnClose

public void rollbackOnClose()

Description copied from interface: DocumentContext

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.

Specified by:

rollbackOnClose in interface DocumentContext

setStart

public void setStart(long start)

Sets the start position of the document context and updates the last start position. This is useful to keep track of the beginning position for reading purposes.

Parameters:

start - The new starting position to set.

toString

public String toString()

Overrides:

toString in class Object