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

Field Summary

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

NOOP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WrappedDocumentContext(DocumentContext dc)

Method Summary

Modifier and Type	Method and Description
void	close()
DocumentContext	dc()
WrappedDocumentContext	dc(DocumentContext dc)
long	index() Index last read, only available for read contexts.
boolean	isData() Checks if the DocumentContext is data.
boolean	isMetaData() Checks it the DocumentContext is metadata.
boolean	isNotComplete()
boolean	isPresent() Checks if the DocumentContext is present.
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
int	sourceId() Returns the source id of this source 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

Constructor Detail

WrappedDocumentContext

protected WrappedDocumentContext(DocumentContext dc)

Method Detail

dc

public DocumentContext dc()

dc

public WrappedDocumentContext dc(DocumentContext dc)

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

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

Returns the source id of this source context. If the id does not exist, -1 is returned instead.

Specified by:

sourceId in interface SourceContext

Returns:

the current source id of this source context or -1 if the source id does not exist.

index

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

Description copied from interface: SourceContext

Index last read, only available for read contexts.

Specified by:

index in interface SourceContext

Returns:

the current Excerpt's index

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if an error occurred while getting the index

isData

public boolean isData()

Description copied from interface: DocumentContext

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

Specified by:

isData in interface DocumentContext

Returns:

true - is the entry is data

rollbackOnClose

public void rollbackOnClose()

Description copied from interface: DocumentContext

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

Specified by:

rollbackOnClose in interface DocumentContext