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

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	isClosed()
boolean	isData()
boolean	isMetaData()
boolean	isNotComplete()
boolean	isPresent()
void	metaData(boolean metaData) Set the metaData flag.
void	notifyClosing()
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()
Wire	wire()

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.core.io.Closeable

closeQuietly, closeQuietly

Constructor Detail

WrappedDocumentContext

protected WrappedDocumentContext(DocumentContext dc)

Method Detail

dc

public DocumentContext dc()

dc

public WrappedDocumentContext dc(DocumentContext dc)

isMetaData

public boolean isMetaData()

Specified by:

isMetaData in interface DocumentContext

Returns:

true - is the entry is of type meta data

metaData

public void metaData(boolean metaData)

Description copied from interface: DocumentContext

Set the metaData flag. When writing this will determine whether the message is written as metaData or not.

Specified by:

metaData in interface DocumentContext

Parameters:

metaData - write as metaData instead of data if true.

isPresent

public boolean isPresent()

Specified by:

isPresent in interface DocumentContext

Returns:

true - if is a document document

wire

@Nullable
public Wire wire()

Specified by:

wire in interface DocumentContext

Returns:

the wire of 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

sourceId

public int sourceId()

Specified by:

sourceId in interface SourceContext

Returns:

the current source id or -1

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 - is the an error occurred while getting the index

isData

public boolean isData()

Specified by:

isData in interface DocumentContext

Returns:

true - is the entry is of type 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

notifyClosing

public void notifyClosing()

isClosed

public boolean isClosed()