Package org.onyx.api

Class Token.SumBuilder

java.lang.Object

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

org.onyx.api.Token.SumBuilder

Enclosing class:

Token

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

A builder class for querying token sums in the ledger.

Field Summary

Fields inherited from class org.onyx.api.BaseQueryBuilder

next

Constructor Summary

Constructors

Constructor	Description
SumBuilder()

Method Summary

Modifier and Type	Method	Description
Token.SumBuilder	addGroupByField(String field)	Adds a field on which token values will be summed.
TokenSum.ItemIterable	getIterable(Client client)	Executes the query, returning an iterable over token sums that match the query.
TokenSum.Page	getPage(Client client)	Executes the query, returning a page of token sums that match the query.
TokenSum.Page	getPage(Client client, String cursor)	Executes the query, returning a page of token sums that match the query beginning with provided cursor.
Token.SumBuilder	setGroupBy(List<String> groupBy)	Specifies the fields on which token values will be summed.

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

SumBuilder

public SumBuilder()

Method Details

getPage

public TokenSum.Page getPage(Client client)
                      throws ChainException

Executes the query, returning a page of token sums that match the query.

Specified by:

getPage in class BaseQueryBuilder<Token.SumBuilder>

Parameters:

client - ledger API connection object

Returns:

a page of token sums

Throws:

ChainException

getPage

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

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

Parameters:

client - ledger API connection object

cursor - string representing encoded query object

Returns:

a page of token sums

Throws:

ChainException

getIterable

public TokenSum.ItemIterable getIterable(Client client)
                                  throws ChainException

Executes the query, returning an iterable over token sums that match the query.

Specified by:

getIterable in class BaseQueryBuilder<Token.SumBuilder>

Parameters:

client - ledger API connection object

Returns:

an iterable over token sums

Throws:

ChainException

setGroupBy

public Token.SumBuilder setGroupBy(List<String> groupBy)

Specifies the fields on which token values will be summed.

Parameters:

groupBy - a list of token fields

Returns:

updated builder

addGroupByField

public Token.SumBuilder addGroupByField(String field)

Adds a field on which token values will be summed.

Parameters:

field - name of a token field

Returns:

updated builder