Package org.onyx.api

Class Action.ListBuilder

java.lang.Object

org.onyx.api.BaseQueryBuilder<Action.ListBuilder>

org.onyx.api.Action.ListBuilder

Enclosing class:

Action

public static class Action.ListBuilder
extends BaseQueryBuilder<Action.ListBuilder>

A builder class for querying actions in the ledger.

List all actions after a certain time:

 Action.ItemIterable actions = new Action.ListBuilder()
   .setFilter("timestamp > $1")
   .addFilterParameter("1985-10-26T01:21:00Z")
   .getIterable(ledger);
 for (Action action : actions) {
   System.out.println("timestamp: " + action.timestamp);
   System.out.println("amount: " + action.amount);
 }
 

Field Summary

Fields inherited from class org.onyx.api.BaseQueryBuilder

next

Constructor Summary

Constructors

Constructor	Description
ListBuilder()

Method Summary

Modifier and Type	Method	Description
Action.ItemIterable	getIterable(Client client)	Executes the query, returning an iterable over actions that match the query.
Action.Page	getPage(Client client)	Executes the query, returning a page of actions that match the query.
Action.Page	getPage(Client client, String cursor)	Executes the query, returning a page of actions that match the query beginning with provided cursor.

Methods inherited from class org.onyx.api.BaseQueryBuilder

addFilterParameter, setFilter, setFilterParameters, setPageSize

Methods inherited from class java.lang.Object

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

Constructor Details

ListBuilder

public ListBuilder()

Method Details

getPage

public Action.Page getPage(Client client)
                    throws ChainException

Executes the query, returning a page of actions that match the query.

Specified by:

getPage in class BaseQueryBuilder<Action.ListBuilder>

Parameters:

client - ledger API connection object

Returns:

a page of actions

Throws:

ChainException

getPage

public Action.Page getPage(Client client,
 String cursor)
                    throws ChainException

Executes the query, returning a page of actions that match the query beginning with provided cursor.

Parameters:

client - ledger API connection object

cursor - string representing encoded query object

Returns:

a page of actions

Throws:

ChainException

getIterable

public Action.ItemIterable getIterable(Client client)
                                throws ChainException

Executes the query, returning an iterable over actions that match the query.

Specified by:

getIterable in class BaseQueryBuilder<Action.ListBuilder>

Parameters:

client - ledger API connection object

Returns:

an iterable over actions

Throws:

ChainException