org.neo4j.cursor

Interface RawCursor<T,EXCEPTION extends Exception>

All Superinterfaces:

AutoCloseable, Supplier<T>

All Known Subinterfaces:

Cursor<T>, IOCursor<T>

All Known Implementing Classes:

GenericCursor

public interface RawCursor<T,EXCEPTION extends Exception>
extends Supplier<T>, AutoCloseable

A cursor is an object that moves to point to different locations in a data structure. The abstraction originally comes from mechanical slide rules, which have a "cursor" which slides to point to different positions on the ruler.

Each position a cursor points to is referred to as a "row".

Access to the current row is done by subtyping this interface and adding accessor methods. If no call to next() has been done, or if it returned false, then such accessor methods throw IllegalStateException.

Method Summary

Modifier and Type	Method and Description
void	close() Signal that the cursor is no longer needed.
boolean	next() Move the cursor to the next row.

Methods inherited from interface java.util.function.Supplier

get

Method Detail

next

boolean next()
      throws EXCEPTION extends Exception

Move the cursor to the next row. Return false if there are no more valid positions, generally indicating that the end of the data structure has been reached.

Throws:

EXCEPTION extends Exception

close

void close()
    throws EXCEPTION extends Exception

Signal that the cursor is no longer needed.

Specified by:

close in interface AutoCloseable

Throws:

EXCEPTION extends Exception