Package org.onyx.api

Class Token.ListBuilder

java.lang.Object

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

org.onyx.api.Token.ListBuilder

Enclosing class:

Token

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

A builder class for querying tokens in the ledger.

List all tokens after a certain time:

 Token.ItemIterable tokens = new Token.ListBuilder()
   .setFilter("timestamp > $1")
   .addFilterParameter("1985-10-26T01:21:00Z")
   .getIterable(ledger);
 for (Token token : tokens) {
   System.out.println("timestamp: " + token.timestamp);
   System.out.println("amount: " + token.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
Token.ItemIterable	getIterable(Client client)	Executes the query, returning an iterable over tokens that match the query.
Token.Page	getPage(Client client)	Executes the query, returning a page of tokens that match the query.
Token.Page	getPage(Client client, String cursor)	Executes the query, returning a page of tokens 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 Token.Page getPage(Client client)
                   throws ChainException

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

Specified by:

getPage in class BaseQueryBuilder<Token.ListBuilder>

Parameters:

client - ledger API connection object

Returns:

a page of tokens

Throws:

ChainException

getPage

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

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

Parameters:

client - ledger API connection object

cursor - string representing encoded query object

Returns:

a page of tokens

Throws:

ChainException

getIterable

public Token.ItemIterable getIterable(Client client)
                               throws ChainException

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

Specified by:

getIterable in class BaseQueryBuilder<Token.ListBuilder>

Parameters:

client - ledger API connection object

Returns:

an iterable over tokens

Throws:

ChainException