NoDocumentContext (OpenHFT/Chronicle-Wire 2.26ea3 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
```
An enumeration implementation of the DocumentContext interface. This context represents a non-existent or uninitialized document context, hence all its methods return default or null values.
This can be useful as a sentinel value or placeholder to avoid null checks in code that works with document contexts. Using `NoDocumentContext.INSTANCE` denotes a guaranteed uninitialized state for a document context.

Enum Constant Summary

Enum Constants
Enum Constant and Description

INSTANCE
The singleton instance of the NoDocumentContext

Enum Constants
Enum Constant and Description
`INSTANCE` The singleton instance of the NoDocumentContext

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()` Closes the `DocumentContext` and releases any held resources.
`long`	`index()` Obtains the index of the last read operation from this source context.
`boolean`	`isData()` Determines if the `DocumentContext` is in an open state.
`boolean`	`isMetaData()` Checks it the `DocumentContext` is metadata.
`boolean`	`isNotComplete()`
`boolean`	`isPresent()` Checks if the `DocumentContext` is present.
`void`	`reset()` Cleans up the `DocumentContext` by invoking the close method, then discarding any lingering state associated with it.
`int`	`sourceId()` Retrieves the source ID associated with this 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, rollbackIfNotComplete, rollbackOnClose

- Enum Constant Detail
  - INSTANCE
```
public static final NoDocumentContext INSTANCE
```
    The singleton instance of the NoDocumentContext
- 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
    
    Determines if the DocumentContext is in an open state. This method essentially checks the inverse of the completion status of the context.
    
    Specified by:
    
    isData in interface DocumentContext
    
    Returns:
    
    true if the context is open (i.e., the NOT_COMPLETE flag is set), false otherwise.
  - 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
    
    Retrieves the source ID associated with this context. A unique identifier that represents the source from which data or operations might be fetched or to which data might be written. If a valid source ID has not been established or isn't available, it defaults to returning -1.
    
    Specified by:
    
    sourceId in interface SourceContext
    
    Returns:
    
    The unique identifier for this source context, or -1 if not available.
  - index
```
public long index()
```
    Description copied from interface: SourceContext
    
    Obtains the index of the last read operation from this source context. This is particularly useful to track the reading progress and can act as a checkpoint or reference point. Note: This method is specifically intended for read contexts and might not be relevant for other context types.
    
    Specified by:
    
    index in interface SourceContext
    
    Returns:
    
    The index corresponding to the last read operation.
  - isNotComplete
```
public boolean isNotComplete()
```
    Specified by:
    
    isNotComplete in interface DocumentContext
    
    Returns:
    
    whether the NOT_COMPLETE flag has been set.
  - close
```
public void close()
```
    Description copied from interface: DocumentContext
    
    Closes the DocumentContext and releases any held resources. It is crucial to ensure that this method is invoked after the context's operations are completed to prevent any potential resource leaks or data corruption.
    
    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
    
    Cleans up the DocumentContext by invoking the close method, then discarding any lingering state associated with it. This provides a way to ensure the context is in a fresh state and free of any residual data or settings.
    
    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