io.vertx.rxjava.sqlclient

Class Cursor

java.lang.Object

io.vertx.rxjava.sqlclient.Cursor

public class Cursor
extends Object

A cursor that reads progressively rows from the database, it is useful for reading very large result sets.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field and Description
static io.vertx.lang.rx.TypeArg<Cursor>	__TYPE_ARG

Constructor Summary

Constructors

Constructor and Description
Cursor(Cursor delegate)
Cursor(Object delegate)

Method Summary

Modifier and Type	Method and Description
void	close() Release the cursor.
void	close(Handler<AsyncResult<Void>> completionHandler) Like close() but with a completionHandler called when the cursor has been released.
boolean	equals(Object o)
Cursor	getDelegate()
int	hashCode()
boolean	hasMore() Returns true when the cursor has results in progress and the read(int, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.sqlclient.RowSet<io.vertx.rxjava.sqlclient.Row>>>) should be called to retrieve them.
boolean	isClosed()
static Cursor	newInstance(Cursor arg)
void	read(int count, Handler<AsyncResult<RowSet<Row>>> handler) Read rows from the cursor, the result is provided asynchronously to the handler.
Single<Void>	rxClose() Like close() but with a completionHandler called when the cursor has been released.
Single<RowSet<Row>>	rxRead(int count) Read rows from the cursor, the result is provided asynchronously to the handler.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final io.vertx.lang.rx.TypeArg<Cursor> __TYPE_ARG

Constructor Detail

Cursor

public Cursor(Cursor delegate)

Cursor

public Cursor(Object delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public Cursor getDelegate()

read

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

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

Parameters:

count - the amount of rows to read

handler - the handler for the result

rxRead

public Single<RowSet<Row>> rxRead(int count)

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

Parameters:

count - the amount of rows to read

Returns:

hasMore

public boolean hasMore()

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

Returns:

whether the cursor has more results,

close

public void close()

Release the cursor.

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

close

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

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

Parameters:

completionHandler -

rxClose

public Single<Void> rxClose()

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

Returns:

isClosed

public boolean isClosed()

Returns:

whether the cursor is closed

newInstance

public static Cursor newInstance(Cursor arg)