net.openhft.chronicle.wire

Class BinaryReadDocumentContext

java.lang.Object

net.openhft.chronicle.wire.BinaryReadDocumentContext

All Implemented Interfaces:

Closeable, AutoCloseable, DocumentContext, ReadDocumentContext, SourceContext

public class BinaryReadDocumentContext
extends Object
implements ReadDocumentContext

Field Summary

Fields

Modifier and Type	Field and Description
long	lastStart
protected boolean	metaData
protected boolean	notComplete
protected boolean	present
protected long	readLimit
protected long	readPosition
protected boolean	rollback
long	start
protected @Nullable AbstractWire	wire

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

NOOP

Constructor Summary

Constructors

Constructor and Description
BinaryReadDocumentContext(@Nullable Wire wire)
BinaryReadDocumentContext(@Nullable Wire wire, boolean ensureFullRead)

Method Summary

Modifier and Type	Method and Description
void	close()
void	closeReadLimit(long readLimit) Sets the read limit for this ReadDocumentContext.
void	closeReadPosition(long readPosition) Sets the read position for this ReadDocumentContext.
long	index() Index last read, only available for read contexts.
boolean	isMetaData() Checks it the DocumentContext is metadata.
boolean	isNotComplete()
boolean	isPresent() Checks if the DocumentContext is present.
void	reset() call close once, then discard any remaining state
protected boolean	rollback()
protected boolean	rollbackIfNeeded() Rolls back document context state to a one before opening if rollback marker is set.
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
void	setStart(long start)
int	sourceId() Returns the source id of this source context.
void	start()
String	toString()
@Nullable Wire	wire() Returns the Wire associated with the Document.

Methods inherited from class java.lang.Object

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

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

isData, isOpen

Field Detail

start

public long start

lastStart

public long lastStart

wire

@Nullable
protected @Nullable AbstractWire wire

present

protected boolean present

notComplete

protected boolean notComplete

readPosition

protected long readPosition

readLimit

protected long readLimit

metaData

protected boolean metaData

rollback

protected boolean rollback

Constructor Detail

BinaryReadDocumentContext

public BinaryReadDocumentContext(@Nullable
                                 @Nullable Wire wire)

BinaryReadDocumentContext

public BinaryReadDocumentContext(@Nullable
                                 @Nullable Wire wire,
                                 boolean ensureFullRead)

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

closeReadPosition

public void closeReadPosition(long readPosition)

Description copied from interface: ReadDocumentContext

Sets the read position for this ReadDocumentContext.

Specified by:

closeReadPosition in interface ReadDocumentContext

closeReadLimit

public void closeReadLimit(long readLimit)

Description copied from interface: ReadDocumentContext

Sets the read limit for this ReadDocumentContext.

Specified by:

closeReadLimit in interface ReadDocumentContext

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.

rollback

protected boolean rollback()

close

public void close()

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

call close once, then discard any remaining state

Specified by:

reset in interface DocumentContext

rollbackIfNeeded

protected boolean rollbackIfNeeded()

Rolls back document context state to a one before opening if rollback marker is set.

Returns:

If rolled back.

start

public void start()

Specified by:

start in interface ReadDocumentContext

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

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.

isNotComplete

public boolean isNotComplete()

Specified by:

isNotComplete in interface DocumentContext

Returns:

whether the NOT_COMPLETE flag has been set.

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

setStart

public void setStart(long start)

toString

public String toString()

Overrides:

toString in class Object