Package org.onyx.api

Class Key.ListBuilder

java.lang.Object

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

org.onyx.api.Key.ListBuilder

Enclosing class:

Key

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

A builder class for listing keys in the ledger.

Field Summary

Fields inherited from class org.onyx.api.BaseQueryBuilder

next

Constructor Summary

Constructors

Constructor	Description
ListBuilder()

Method Summary

Modifier and Type	Method	Description
Key.ItemIterable	getIterable(Client client)	Executes the query, returning an iterable over keys that match the query.
Key.Page	getPage(Client client)	Executes the query, returning a page of keys that match the query.
Key.Page	getPage(Client client, String cursor)	Executes the query, returning a page of keys 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 Key.Page getPage(Client client)
                 throws ChainException

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

Specified by:

getPage in class BaseQueryBuilder<Key.ListBuilder>

Parameters:

client - ledger API connection object

Returns:

a page of keys

Throws:

ChainException

getPage

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

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

Parameters:

client - ledger API connection object

cursor - string representing encoded query object

Returns:

a page of keys

Throws:

ChainException

getIterable

public Key.ItemIterable getIterable(Client client)
                             throws ChainException

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

Specified by:

getIterable in class BaseQueryBuilder<Key.ListBuilder>

Parameters:

client - ledger API connection object

Returns:

an iterable over keys

Throws:

ChainException