net.openhft.chronicle.wire

Enum NoDocumentContext

java.lang.Object

java.lang.Enum<NoDocumentContext>

net.openhft.chronicle.wire.NoDocumentContext

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Comparable<NoDocumentContext>, net.openhft.chronicle.core.io.QueryCloseable, DocumentContext, SourceContext

public enum NoDocumentContext
extends Enum<NoDocumentContext>
implements DocumentContext

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
void	close()
long	index() Index last read, only available for read contexts.
boolean	isData()
boolean	isMetaData()
boolean	isNotComplete()
boolean	isPresent()
void	metaData(boolean metaData) Set the metaData flag.
int	sourceId()
static NoDocumentContext	valueOf(String name) Returns the enum constant of this type with the specified name.
static NoDocumentContext[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
Wire	wire()

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

isClosed, rollbackOnClose

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

closeQuietly, closeQuietly, notifyClosing

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

throwExceptionIfClosed

Enum Constant Detail

INSTANCE

public static final NoDocumentContext INSTANCE

Method Detail

values

public static NoDocumentContext[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NoDocumentContext c : NoDocumentContext.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NoDocumentContext valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

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

isData

public boolean isData()

Specified by:

isData in interface DocumentContext

Returns:

true - is the entry is of type data

wire

public Wire wire()

Specified by:

wire in interface DocumentContext

Returns:

the wire of the document

sourceId

public int sourceId()

Specified by:

sourceId in interface SourceContext

Returns:

the current source id or -1

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

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