net.openhft.chronicle.wire

Class ReadDocumentContext

java.lang.Object

net.openhft.chronicle.wire.ReadDocumentContext

All Implemented Interfaces:

Closeable, AutoCloseable, DocumentContext, SourceContext

public class ReadDocumentContext
extends Object
implements DocumentContext

Created by peter on 24/12/15.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	notComplete
protected boolean	present
protected AbstractWire	wire

Constructor Summary

Constructors

Constructor and Description
ReadDocumentContext(Wire wire)

Method Summary

Modifier and Type	Method and Description
void	close()
void	closeReadLimit(long readLimit)
void	closeReadPosition(long readPosition)
long	index() Index last read, only available for read contexts.
boolean	isMetaData()
boolean	isNotComplete()
boolean	isPresent()
void	metaData(boolean metaData) Set the metaData flag.
int	sourceId()
void	start()
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.wire.DocumentContext

isData

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

closeQuietly, isClosed, notifyClosing

Field Detail

wire

protected AbstractWire wire

present

protected boolean present

notComplete

protected boolean notComplete

Constructor Detail

ReadDocumentContext

public ReadDocumentContext(@Nullable
                           Wire wire)

Method Detail

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

closeReadPosition

public void closeReadPosition(long readPosition)

closeReadLimit

public void closeReadLimit(long readLimit)

wire

public Wire wire()

Specified by:

wire in interface DocumentContext

Returns:

the wire of the document

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

start

public void start()

index

public long index()

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

sourceId

public int sourceId()

Specified by:

sourceId in interface SourceContext

Returns:

the current source id or -1

isNotComplete

public boolean isNotComplete()

Specified by:

isNotComplete in interface DocumentContext

Returns:

whether the NOT_COMPLETE flag has been set.