NoDocumentContext (OpenHFT/Chronicle-Wire 2.24ea27 API)

java.lang.Object
- java.lang.Enum<NoDocumentContext>
- - net.openhft.chronicle.wire.NoDocumentContext

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Comparable<NoDocumentContext>, DocumentContext, SourceContext
```
public enum NoDocumentContext
extends Enum<NoDocumentContext>
implements DocumentContext
```

Enum Constant Summary

Enum Constants
Enum Constant and Description

INSTANCE

Enum Constants
Enum Constant and Description
`INSTANCE`

Field Summary
- Fields inherited from interface net.openhft.chronicle.wire.DocumentContext
  NOOP

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`long`	`index()` Index last read, only available for read contexts.
`boolean`	`isData()` Checks if the `DocumentContext` is data.
`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.
`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()` Returns the `Wire` associated with the `Document`.

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
isOpen, rollbackOnClose

- 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()
```
    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
  - isData
```
public boolean isData()
```
    Description copied from interface: DocumentContext
    
    Checks if the DocumentContext is data. If it is, true is returned, otherwise false
    
    Specified by:
    
    isData in interface DocumentContext
    
    Returns:
    
    true - is the entry is data
  - 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.
  - 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()
```
    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
    
    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

Enum NoDocumentContext

Enum Constant Summary

Field Summary

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

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

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

Enum Constant Detail

INSTANCE

Method Detail

values

valueOf

isMetaData

isPresent

isData

wire

sourceId

index

isNotComplete

close

reset