io.vertx.sqlclient.impl

Class CursorImpl

java.lang.Object

io.vertx.sqlclient.impl.CursorImpl

All Implemented Interfaces:

Cursor

public class CursorImpl
extends Object
implements Cursor

Author:

Julien Viet

Method Summary

Modifier and Type	Method and Description
Future<Void>	close() Release the cursor.
void	close(Handler<AsyncResult<Void>> completionHandler) Like Cursor.close() but with a completionHandler called when the cursor has been released.
boolean	hasMore() Returns true when the cursor has results in progress and the Cursor.read(int, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.sqlclient.RowSet<io.vertx.sqlclient.Row>>>) should be called to retrieve them.
boolean	isClosed()
Future<RowSet<Row>>	read(int count) Like Cursor.read(int, Handler) but returns a Future of the asynchronous result
void	read(int count, Handler<AsyncResult<RowSet<Row>>> handler) Read rows from the cursor, the result is provided asynchronously to the handler.

Methods inherited from class java.lang.Object

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

Method Detail

hasMore

public boolean hasMore()

Description copied from interface: Cursor

Returns true when the cursor has results in progress and the Cursor.read(int, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.sqlclient.RowSet<io.vertx.sqlclient.Row>>>) should be called to retrieve them.

Specified by:

hasMore in interface Cursor

Returns:

whether the cursor has more results,

read

public void read(int count,
                 Handler<AsyncResult<RowSet<Row>>> handler)

Description copied from interface: Cursor

Read rows from the cursor, the result is provided asynchronously to the handler.

Specified by:

read in interface Cursor

Parameters:

count - the amount of rows to read

handler - the handler for the result

read

public Future<RowSet<Row>> read(int count)

Description copied from interface: Cursor

Like Cursor.read(int, Handler) but returns a Future of the asynchronous result

Specified by:

read in interface Cursor

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Cursor

Returns:

whether the cursor is closed

close

public void close(Handler<AsyncResult<Void>> completionHandler)

Description copied from interface: Cursor

Like Cursor.close() but with a completionHandler called when the cursor has been released.

Specified by:

close in interface Cursor

close

public Future<Void> close()

Description copied from interface: Cursor

Release the cursor.

It should be called for prepared queries executed with a fetch size.

Specified by:

close in interface Cursor