net.openhft.chronicle.wire

Class WrappedDocumentContext

java.lang.Object

net.openhft.chronicle.wire.WrappedDocumentContext

All Implemented Interfaces:

Closeable, AutoCloseable, DocumentContext, SourceContext

public abstract class WrappedDocumentContext
extends Object
implements DocumentContext

This is the WrappedDocumentContext class which implements the DocumentContext interface. The purpose of this class is to wrap another DocumentContext and delegate the behavior to the wrapped instance. This can be used as a base for any specialized versions of DocumentContext which need to extend the default behavior.

Field Summary

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

NOOP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WrappedDocumentContext(DocumentContext dc) Constructs a new instance of WrappedDocumentContext that wraps the provided DocumentContext.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the DocumentContext and releases any held resources.
DocumentContext	dc() Getter method to retrieve the wrapped DocumentContext instance.
WrappedDocumentContext	dc(DocumentContext dc) Setter method to update the wrapped DocumentContext instance.
long	index() Obtains the index of the last read operation from this source context.
boolean	isData() Determines if the DocumentContext is in an open state.
boolean	isMetaData() Checks it the DocumentContext is metadata.
boolean	isNotComplete()
boolean	isPresent() Checks if the DocumentContext is present.
void	rollbackOnClose() Invoked to signal an error condition in the current context.
int	sourceId() Retrieves the source ID associated with this context.
@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

isOpen, reset, rollbackIfNotComplete

Constructor Detail

WrappedDocumentContext

protected WrappedDocumentContext(DocumentContext dc)

Constructs a new instance of WrappedDocumentContext that wraps the provided DocumentContext.

Parameters:

dc - The DocumentContext to be wrapped.

Method Detail

dc

public DocumentContext dc()

Getter method to retrieve the wrapped DocumentContext instance.

Returns:

The wrapped DocumentContext instance.

dc

public WrappedDocumentContext dc(DocumentContext dc)

Setter method to update the wrapped DocumentContext instance. This method is designed to follow the builder pattern, returning the current instance for chained calls.

Parameters:

dc - The new DocumentContext instance to be wrapped.

Returns:

The current instance of WrappedDocumentContext.

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.

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

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.

isData

public boolean isData()

Description copied from interface: DocumentContext

Determines if the DocumentContext is in an open state. This method essentially checks the inverse of the completion status of the context.

Specified by:

isData in interface DocumentContext

Returns:

true if the context is open (i.e., the NOT_COMPLETE flag is set), false otherwise.

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