net.openhft.chronicle.wire

Class DocumentContextHolder

java.lang.Object

net.openhft.chronicle.wire.DocumentContextHolder

All Implemented Interfaces:

Closeable, AutoCloseable, DocumentContext, SourceContext, WriteDocumentContext

public class DocumentContextHolder
extends Object
implements DocumentContext, WriteDocumentContext

This is the DocumentContextHolder class which implements both DocumentContext and WriteDocumentContext. It acts as a wrapper or a delegate around an instance of DocumentContext, providing methods to interact with the encapsulated context.

Field Summary

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

NOOP

Constructor Summary

Constructors

Constructor and Description
DocumentContextHolder()

Method Summary

Modifier and Type	Method and Description
boolean	chainedElement() Returns true if this WriteDocumentContext is a chained element.
void	chainedElement(boolean chainedElement) Marks this WriteDocumentContext as a chained element.
void	close() Closes the DocumentContext and releases any held resources.
DocumentContext	documentContext() Retrieves the encapsulated DocumentContext instance.
void	documentContext(DocumentContext dc) Sets the encapsulated DocumentContext instance to the provided value.
long	index() Obtains the index of the last read operation from this source context.
boolean	isClosed() Determines if the DocumentContextHolder has been closed or not.
boolean	isEmpty() Checks if the writing context is empty.
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.
int	sourceId() Retrieves the source ID associated with this context.
void	start(boolean metaData) Initializes the writing context with a specific metadata status.
@Nullable Wire	wire() Returns the Wire associated with the Document.

Methods inherited from class java.lang.Object

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

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

isData, isOpen, rollbackIfNotComplete, rollbackOnClose

Constructor Detail

DocumentContextHolder

public DocumentContextHolder()

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

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.

isNotComplete

public boolean isNotComplete()

Specified by:

isNotComplete in interface DocumentContext

Returns:

whether the NOT_COMPLETE flag has been set.

documentContext

public DocumentContext documentContext()

Retrieves the encapsulated DocumentContext instance.

Returns:

The current DocumentContext instance.

documentContext

public void documentContext(DocumentContext dc)

Sets the encapsulated DocumentContext instance to the provided value.

Parameters:

dc - The new DocumentContext to be set.

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

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.

index

public long index()
           throws net.openhft.chronicle.core.io.IORuntimeException

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.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if any issue arises while fetching the index.

isClosed

public boolean isClosed()

Determines if the DocumentContextHolder has been closed or not. This method checks if the encapsulated DocumentContext is null, indicating a closed state.

Returns:

true if the holder is closed (i.e., the internal DocumentContext is null), false otherwise.

start

public void start(boolean metaData)

Description copied from interface: WriteDocumentContext

Initializes the writing context with a specific metadata status.

Specified by:

start in interface WriteDocumentContext

Parameters:

metaData - A boolean value indicating if the context is metadata.

chainedElement

public boolean chainedElement()

Description copied from interface: WriteDocumentContext

Returns true if this WriteDocumentContext is a chained element.

Specified by:

chainedElement in interface WriteDocumentContext

Returns:

true if this WriteDocumentContext is a chained element; otherwise, false.

chainedElement

public void chainedElement(boolean chainedElement)

Description copied from interface: WriteDocumentContext

Marks this WriteDocumentContext as a chained element.

Specified by:

chainedElement in interface WriteDocumentContext

Parameters:

chainedElement - A boolean value indicating if the context is a chained element.

isEmpty

public boolean isEmpty()

Description copied from interface: WriteDocumentContext

Checks if the writing context is empty.

Specified by:

isEmpty in interface WriteDocumentContext

Returns:

true if the context is empty; otherwise, false.