net.openhft.chronicle.wire

Class TextReadDocumentContext

java.lang.Object

net.openhft.chronicle.wire.TextReadDocumentContext

All Implemented Interfaces:

Closeable, AutoCloseable, DocumentContext, ReadDocumentContext, SourceContext

public class TextReadDocumentContext
extends Object
implements ReadDocumentContext

This class represents the context for reading a document in textual format. It provides methods and utilities for understanding the structure and boundaries of the document within a given wire format.

Field Summary

Fields

Modifier and Type	Field and Description
static net.openhft.chronicle.bytes.BytesStore<?,?>	EOD_SEP
protected boolean	notComplete
protected boolean	present
static net.openhft.chronicle.bytes.BytesStore<?,?>	SOD_SEP
protected @Nullable AbstractWire	wire

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

NOOP

Constructor Summary

Constructors

Constructor and Description
TextReadDocumentContext(@Nullable AbstractWire wire) Constructor for the TextReadDocumentContext.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the DocumentContext and releases any held resources.
void	closeReadLimit(long readLimit) Sets the read limit for this ReadDocumentContext.
void	closeReadPosition(long readPosition) Sets the read position for this ReadDocumentContext.
static void	consumeToEndOfMessage(net.openhft.chronicle.bytes.Bytes<?> bytes) Consumes the bytes until the end of the message is encountered.
long	index() Obtains the index of the last read operation from this source context.
static boolean	isEndOfMessage(net.openhft.chronicle.bytes.Bytes<?> bytes) Checks if the current position in the bytes denotes the end of a message.
boolean	isMetaData() Checks it the DocumentContext is metadata.
boolean	isNotComplete()
boolean	isPresent() Checks if the DocumentContext is present.
protected static boolean	isWhiteSpaceAt(net.openhft.chronicle.bytes.Bytes<?> bytes) Determines if the byte at a specific position (offset by 3 from current) is a whitespace.
void	reset() Cleans up the DocumentContext by invoking the close method, then discarding any lingering state associated with it.
void	rollbackOnClose() Invoked to signal an error condition in the current context.
protected void	skipSep(net.openhft.chronicle.bytes.Bytes<?> bytes) Skips the document separator sequence (3 bytes) in the given bytes.
int	sourceId() Retrieves the source ID associated with this context.
void	start() Initiates the start of reading within the context.
String	toString()
@Nullable Wire	wire() Returns the Wire associated with the Document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

isData, isOpen, rollbackIfNotComplete

Field Detail

SOD_SEP

public static final net.openhft.chronicle.bytes.BytesStore<?,?> SOD_SEP

EOD_SEP

public static final net.openhft.chronicle.bytes.BytesStore<?,?> EOD_SEP

wire

@Nullable
protected @Nullable AbstractWire wire

present

protected boolean present

notComplete

protected boolean notComplete

Constructor Detail

TextReadDocumentContext

public TextReadDocumentContext(@Nullable
                               @Nullable AbstractWire wire)

Constructor for the TextReadDocumentContext.

Parameters:

wire - The wire instance to be used by this context. Can be null.

Method Detail

consumeToEndOfMessage

public static void consumeToEndOfMessage(net.openhft.chronicle.bytes.Bytes<?> bytes)

Consumes the bytes until the end of the message is encountered. Skips bytes that do not denote the end of the document.

Parameters:

bytes - The bytes to be consumed.

isEndOfMessage

public static boolean isEndOfMessage(net.openhft.chronicle.bytes.Bytes<?> bytes)

Checks if the current position in the bytes denotes the end of a message. This is done by checking if the bytes start with either the start or end document separator.

Parameters:

bytes - The bytes to be checked.

Returns:

True if it's the end of a message; false otherwise.

isWhiteSpaceAt

protected static boolean isWhiteSpaceAt(net.openhft.chronicle.bytes.Bytes<?> bytes)

Determines if the byte at a specific position (offset by 3 from current) is a whitespace.

Parameters:

bytes - The bytes to be checked.

Returns:

True if the byte is whitespace; false otherwise.

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

closeReadPosition

public void closeReadPosition(long readPosition)

Description copied from interface: ReadDocumentContext

Sets the read position for this ReadDocumentContext. This defines the starting point within the document from which reading should begin.

Specified by:

closeReadPosition in interface ReadDocumentContext

Parameters:

readPosition - The long value representing the read position.

closeReadLimit

public void closeReadLimit(long readLimit)

Description copied from interface: ReadDocumentContext

Sets the read limit for this ReadDocumentContext. This defines the boundary or endpoint within the document up to which reading should occur.

Specified by:

closeReadLimit in interface ReadDocumentContext

Parameters:

readLimit - The long value representing the read limit.

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.

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

start

public void start()

Description copied from interface: ReadDocumentContext

Initiates the start of reading within the context.

Specified by:

start in interface ReadDocumentContext

skipSep

protected void skipSep(net.openhft.chronicle.bytes.Bytes<?> bytes)

Skips the document separator sequence (3 bytes) in the given bytes. It also resets the state of the wire's value input and consumes any padding present.

Parameters:

bytes - The bytes in which the separator sequence should be skipped.

rollbackOnClose

public void rollbackOnClose()

Description copied from interface: DocumentContext

Invoked to signal an error condition in the current context. This ensures that upon closing the context, any changes made during its lifecycle are rolled back rather than committing a potentially erroneous state.

Specified by:

rollbackOnClose in interface DocumentContext

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.

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.

isNotComplete

public boolean isNotComplete()

Specified by:

isNotComplete in interface DocumentContext

Returns:

whether the NOT_COMPLETE flag has been set.

toString

public String toString()

Overrides:

toString in class Object