Class Cursor.Builder (2.0.0)

public static final class Cursor.Builder

A builder which constructs Cursor objects.

Inheritance

java.lang.Object > Cursor.Builder

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build()

public Cursor build()

Construct the final message.

Returns
Type	Description
Cursor	the Cursor built from the parameters entered on this Builder

build(String webSafeString)

public Cursor build(String webSafeString)

Construct the final message.

Parameter
Name	Description
webSafeString	String use a cursor returned from a previous set of search results as a starting point to retrieve the next set of results. This can get you better performance, and also improves the consistency of pagination through index updates

Returns
Type	Description
Cursor	the Cursor built from the parameters entered on this Builder

setPerResult(boolean perResult)

public Cursor.Builder setPerResult(boolean perResult)

Sets whether or not to return a Cursor on each individual result in Results or a single cursor with all Results.

Parameter
Name	Description
perResult	boolean if True, then return a Cursor with each ScoredDocument result, otherwise return a single Cursor with Results

Returns
Type	Description
Cursor.Builder	this Builder