org.stellar.sdk.requests

Class ClaimableBalancesRequestBuilder

java.lang.Object

org.stellar.sdk.requests.RequestBuilder

org.stellar.sdk.requests.ClaimableBalancesRequestBuilder

public class ClaimableBalancesRequestBuilder
extends RequestBuilder

Builds requests connected to claimable balances.

Nested Class Summary

Nested classes/interfaces inherited from class org.stellar.sdk.requests.RequestBuilder

RequestBuilder.Order

Constructor Summary

Constructors

Constructor and Description
ClaimableBalancesRequestBuilder(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl serverURI)

Method Summary

Modifier and Type	Method and Description
ClaimableBalanceResponse	claimableBalance(okhttp3.HttpUrl uri) Requests specific uri and returns ClaimableBalanceResponse.
ClaimableBalanceResponse	claimableBalance(java.lang.String id) The claimable balance details endpoint provides information on a claimable balance.
ClaimableBalancesRequestBuilder	cursor(java.lang.String token) Sets cursor parameter on the request.
Page<ClaimableBalanceResponse>	execute() Build and execute request.
static Page<ClaimableBalanceResponse>	execute(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl uri) Requests specific uri and returns Page of ClaimableBalanceResponse.
ClaimableBalancesRequestBuilder	forAsset(Asset asset) Returns all claimable balances which hold a given asset.
ClaimableBalancesRequestBuilder	forClaimant(java.lang.String claimant) Returns all claimable balances which can be claimed by a given account id.
ClaimableBalancesRequestBuilder	forSponsor(java.lang.String sponsor) Returns all claimable balances sponsored by a given account.
ClaimableBalancesRequestBuilder	limit(int number) Sets limit parameter on the request.
ClaimableBalancesRequestBuilder	order(RequestBuilder.Order direction) Sets order parameter on the request.

Methods inherited from class org.stellar.sdk.requests.RequestBuilder

setAssetParameter, setAssetsParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

ClaimableBalancesRequestBuilder

public ClaimableBalancesRequestBuilder(okhttp3.OkHttpClient httpClient,
                                       okhttp3.HttpUrl serverURI)

Method Detail

claimableBalance

public ClaimableBalanceResponse claimableBalance(okhttp3.HttpUrl uri)

Requests specific uri and returns ClaimableBalanceResponse. This method is helpful for getting the links.

Returns:

ClaimableBalanceResponse

Throws:

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

claimableBalance

public ClaimableBalanceResponse claimableBalance(java.lang.String id)

The claimable balance details endpoint provides information on a claimable balance.

Parameters:

id - specifies which claimable balance to load.

Returns:

The claimable balance details.

Throws:

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

forSponsor

public ClaimableBalancesRequestBuilder forSponsor(java.lang.String sponsor)

Returns all claimable balances sponsored by a given account.

Parameters:

sponsor - Account ID of the sponsor.

Returns:

current ClaimableBalancesRequestBuilder instance

forAsset

public ClaimableBalancesRequestBuilder forAsset(Asset asset)

Returns all claimable balances which hold a given asset.

Parameters:

asset - The Asset held by the claimable balance.

Returns:

current ClaimableBalancesRequestBuilder instance

forClaimant

public ClaimableBalancesRequestBuilder forClaimant(java.lang.String claimant)

Returns all claimable balances which can be claimed by a given account id.

Parameters:

claimant - Account ID of the address which can claim the claimable balance.

Returns:

current ClaimableBalancesRequestBuilder instance

execute

public static Page<ClaimableBalanceResponse> execute(okhttp3.OkHttpClient httpClient,
                                                     okhttp3.HttpUrl uri)

Requests specific uri and returns Page of ClaimableBalanceResponse. This method is helpful for getting the next set of results.

Parameters:

httpClient - OkHttpClient to use to send the request.

uri - HttpUrl URI to send the request to.

Returns:

Page of ClaimableBalanceResponse

Throws:

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

ConnectionErrorException - if the request fails due to an IOException, including but not limited to a timeout, connection failure etc.

TooManyRequestsException - when too many requests were sent to the Horizon server.

execute

public Page<ClaimableBalanceResponse> execute()

Build and execute request.

Returns:

Page of AssetResponse

Throws:

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

ConnectionErrorException - if the request fails due to an IOException, including but not limited to a timeout, connection failure etc.

TooManyRequestsException - when too many requests were sent to the Horizon server.

cursor

public ClaimableBalancesRequestBuilder cursor(java.lang.String token)

Description copied from class: RequestBuilder

Sets cursor parameter on the request. A cursor is a value that points to a specific location in a collection of resources. The cursor attribute itself is an opaque value meaning that users should not try to parse it.

Overrides:

cursor in class RequestBuilder

Parameters:

token - A cursor is a value that points to a specific location in a collection of resources.

See Also:

Page documentation

limit

public ClaimableBalancesRequestBuilder limit(int number)

Description copied from class: RequestBuilder

Sets limit parameter on the request. It defines maximum number of records to return. For range and default values check documentation of the endpoint requested.

Overrides:

limit in class RequestBuilder

Parameters:

number - maxium number of records to return

order

public ClaimableBalancesRequestBuilder order(RequestBuilder.Order direction)

Description copied from class: RequestBuilder

Sets order parameter on the request.

Overrides:

order in class RequestBuilder

Parameters:

direction - RequestBuilder.Order