org.mule.runtime.api.streaming

Interface Cursor

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

CursorIterator<T>

All Known Implementing Classes:

CursorStream

public interface Cursor
extends Closeable

Provides random access to a stream of data. By stream, you should not assume an InputStream (although such implementation exists), but instead consider a conceptual stream, regardless of its nature.

It works by adding the concept of a zero-based position. Each position represents one byte in the stream. Each time data is pulled from this stream, the position advances as many bytes as read. However, the seek(long) method can be used to reset the position.

Implementations should not be expected to be thread safe. Should not be used concurrently.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
void	close() For a Cursor, to be closed means that this cursor should not provide any more data.
long	getPosition()
CursorProvider	getProvider()
boolean	isReleased()
void	release() Releases all the resources that this cursor allocated.
void	seek(long position) Updates the cursor's position.

Method Detail

getPosition

long getPosition()

Returns:

The cursor's current position

seek

void seek(long position)
   throws IOException

Updates the cursor's position.

Parameters:

position - the new position

Throws:

IOException

release

void release()

Releases all the resources that this cursor allocated.

Implementation of this method must be idempotent and thread-safe.

This method should only be called by the Runtime. Once that happens, the isReleased() method will start to return true

isReleased

boolean isReleased()

Returns:

Whether the release() method has been called on this instance

getProvider

CursorProvider getProvider()

Returns:

The CursorProvider which generated this cursor

close

void close()
    throws IOException

For a Cursor, to be closed means that this cursor should not provide any more data. It does not mean that allocated resources will be released, that's what the release() method is for. Depending on the concrete cursor type, closed cursors might be re-opened or not.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException