net.openhft.chronicle.wire

Class TextWriteDocumentContext

java.lang.Object

net.openhft.chronicle.wire.TextWriteDocumentContext

All Implemented Interfaces:

Closeable, AutoCloseable, DocumentContext, SourceContext, WriteDocumentContext

public class TextWriteDocumentContext
extends Object
implements WriteDocumentContext

Field Summary

Fields

Modifier and Type	Field and Description
protected int	count
protected long	position
protected Wire	wire

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

NOOP

Constructor Summary

Constructors

Constructor and Description
TextWriteDocumentContext(Wire wire)

Method Summary

Modifier and Type	Method and Description
boolean	chainedElement() Returns true if this WriteDocumentContext is a chained element.
void	chainedElement(boolean chainedElement) Marks this WriteDocumentContext as a chained element.
void	close()
long	index() Index last read, only available for read contexts.
boolean	isEmpty()
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
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.
void	start(boolean metaData)
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

isData, isOpen

Field Detail

wire

protected Wire wire

count

protected int count

position

protected long position

Constructor Detail

TextWriteDocumentContext

public TextWriteDocumentContext(Wire wire)

Method Detail

start

public void start(boolean metaData)

Specified by:

start in interface WriteDocumentContext

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface WriteDocumentContext

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

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

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

chainedElement

public boolean chainedElement()

Description copied from interface: WriteDocumentContext

Returns true if this WriteDocumentContext is a chained element.

Specified by:

chainedElement in interface WriteDocumentContext

Returns:

true if this WriteDocumentContext is a chained element.

chainedElement

public void chainedElement(boolean chainedElement)

Description copied from interface: WriteDocumentContext

Marks this WriteDocumentContext as a chained element.

Specified by:

chainedElement in interface WriteDocumentContext

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

public 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.

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.