net.openhft.chronicle.wire

Class DocumentContextHolder

java.lang.Object

net.openhft.chronicle.wire.DocumentContextHolder

All Implemented Interfaces:

Closeable, AutoCloseable, DocumentContext, SourceContext, WriteDocumentContext

public class DocumentContextHolder
extends Object
implements DocumentContext, WriteDocumentContext

Field Summary

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

NOOP

Constructor Summary

Constructors

Constructor and Description
DocumentContextHolder()

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()
DocumentContext	documentContext()
void	documentContext(DocumentContext dc)
long	index() Index last read, only available for read contexts.
boolean	isClosed()
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
int	sourceId() Returns the source id of this source context.
void	start(boolean metaData)
@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

isData, isOpen, rollbackOnClose

Constructor Detail

DocumentContextHolder

public DocumentContextHolder()

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

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.

documentContext

public DocumentContext documentContext()

documentContext

public void documentContext(DocumentContext dc)

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

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

isClosed

public boolean isClosed()

start

public void start(boolean metaData)

Specified by:

start in interface WriteDocumentContext

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

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface WriteDocumentContext