Package org.stellar.sdk.requests
Class RequestBuilder
- java.lang.Object
-
- org.stellar.sdk.requests.RequestBuilder
-
- Direct Known Subclasses:
AccountsRequestBuilder
,AssetsRequestBuilder
,ClaimableBalancesRequestBuilder
,EffectsRequestBuilder
,FeeStatsRequestBuilder
,LedgersRequestBuilder
,LiquidityPoolsRequestBuilder
,OffersRequestBuilder
,OperationsRequestBuilder
,OrderBookRequestBuilder
,PaymentsRequestBuilder
,StrictReceivePathsRequestBuilder
,StrictSendPathsRequestBuilder
,TradeAggregationsRequestBuilder
,TradesRequestBuilder
,TransactionsRequestBuilder
public abstract class RequestBuilder extends java.lang.Object
Abstract class for request builders.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RequestBuilder.Order
Represents possibleorder
parameter values.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RequestBuilder
cursor(java.lang.String cursor)
Setscursor
parameter on the request.RequestBuilder
limit(int number)
Setslimit
parameter on the request.RequestBuilder
order(RequestBuilder.Order direction)
Setsorder
parameter on the request.RequestBuilder
setAssetParameter(java.lang.String name, Asset asset)
Sets a parameter consisting of an asset represented as "assetCode:assetIssue" on the request.RequestBuilder
setAssetsParameter(java.lang.String name, java.util.List<Asset> assets)
Sets a parameter consisting of a comma separated list of assets on the request.
-
-
-
Method Detail
-
cursor
public RequestBuilder cursor(java.lang.String cursor)
Setscursor
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.- Parameters:
cursor
-- See Also:
- Page documentation
-
limit
public RequestBuilder limit(int number)
Setslimit
parameter on the request. It defines maximum number of records to return. For range and default values check documentation of the endpoint requested.- Parameters:
number
- maxium number of records to return
-
order
public RequestBuilder order(RequestBuilder.Order direction)
Setsorder
parameter on the request.- Parameters:
direction
-RequestBuilder.Order
-
setAssetsParameter
public RequestBuilder setAssetsParameter(java.lang.String name, java.util.List<Asset> assets)
Sets a parameter consisting of a comma separated list of assets on the request.- Parameters:
name
- the name of the query parameterassets
- the list of assets to be serialized into the query parameter value
-
setAssetParameter
public RequestBuilder setAssetParameter(java.lang.String name, Asset asset)
Sets a parameter consisting of an asset represented as "assetCode:assetIssue" on the request.- Parameters:
name
- the name of the query parameterasset
- the asset to be serialized into the query parameter value
-
-