Package jp.gopay.sdk.builders

Class RetrofitRequestBuilderPaginated<E extends SimpleModel,R,T,C extends BaseId>

java.lang.Object

jp.gopay.sdk.builders.RetrofitRequestBuilder<PaginatedList<E>,R>

jp.gopay.sdk.builders.RetrofitRequestBuilderPaginated<E,R,T,C>

All Implemented Interfaces:

Paginator<E,T,C>, RequestBuilder<PaginatedList<E>,Request<PaginatedList<E>>>

Direct Known Subclasses:

AbstractApplicationTokenBuilders.AbstractListApplicationTokenRequestBuilder, AbstractBankAccountsBuilders.AbstractListAllBankAccountsRequestBuilder, AbstractCancelsBuilders.AbstractListAllCancelsRequestBuilder, AbstractChargesBuilders.AbstractListChargesRequestBuilder, AbstractLedgersBuilders.AbstractListLedgersRequestBuilder, AbstractMerchantsBuilders.AbstractGetTransactionHistoryRequestBuilder, AbstractRefundBuilders.AbstractListRefundsRequestBuilder, AbstractStoreBuilders.AbstractListStoresRequestBuilder, AbstractSubscriptionBuilders.AbstractListChargesForPaymentRequestBuilder, AbstractSubscriptionBuilders.AbstractListScheduledPaymentsRequestBuilder, AbstractSubscriptionBuilders.AbstractListSubscriptionChargesRequestBuilder, AbstractSubscriptionBuilders.AbstractListSubscriptionsMerchantRequestBuilder, AbstractSubscriptionBuilders.AbstractListSubscriptionsRequestBuilder, AbstractTransactionTokensBuilders.AbstractListTransactionTokensMerchantRequestBuilder, AbstractTransactionTokensBuilders.AbstractListTransactionTokensRequestBuilder, AbstractTransferBuilders.AbstractListTransferRequestBuilder, AbstractWebhookBuilders.AbstractListWebhookMerchantRequestBuilder, AbstractWebhookBuilders.AbstractListWebhookRequestBuilder

public abstract class RetrofitRequestBuilderPaginated<E extends SimpleModel,R,T,C extends BaseId>
extends RetrofitRequestBuilder<PaginatedList<E>,R>
implements Paginator<E,T,C>

Created by nasu on 2017/06/29.

Constructor Summary

Constructors

Constructor	Description
RetrofitRequestBuilderPaginated(retrofit2.Retrofit retrofit)

Method Summary

Modifier and Type	Method	Description
PaginatedListIterable<E>	asIterable()
PaginatedListIterable<E>	asIterable(long timeout)
PaginatedListIterable<E>	asIterable(long timeout, Backoff backoff)
C	getCursor()
CursorDirection	getCursorDirection()
Integer	getLimit()
T	setCursor(C cursor)	Sets the cursor.
T	setCursorDirection(CursorDirection cursorDirection)	Sets the direction of the cursor.
T	setLimit(Integer limit)	Sets the maximum number of responses to be returned by the API.

Methods inherited from class java.lang.Object

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

Methods inherited from class jp.gopay.sdk.builders.RetrofitRequestBuilder

build, getRequest

Constructor Detail

RetrofitRequestBuilderPaginated

public RetrofitRequestBuilderPaginated(retrofit2.Retrofit retrofit)

Method Detail

setLimit

public T setLimit(Integer limit)

Description copied from interface: Paginator

Sets the maximum number of responses to be returned by the API.

Specified by:

setLimit in interface Paginator<E extends SimpleModel,R,T>

Parameters:

limit - is an integer value that represents the maximum number of items returned by the API

Returns:

a request object

setCursorDirection

public T setCursorDirection(CursorDirection cursorDirection)

Description copied from interface: Paginator

Sets the direction of the cursor.

Specified by:

setCursorDirection in interface Paginator<E extends SimpleModel,R,T>

Parameters:

cursorDirection - is a member of the CursorDirection enum

Returns:

a request object

See Also:

CursorDirection

setCursor

public T setCursor(C cursor)

Description copied from interface: Paginator

Sets the cursor.

Specified by:

setCursor in interface Paginator<E extends SimpleModel,R,T>

Parameters:

cursor - is the cursor used by the API to return a list of items following the other pagination parameters. The cursor usually equals the value of the ID of some item for which a list is being queried.

Returns:

a request object.

See Also:

BaseId

getLimit

public Integer getLimit()

getCursorDirection

public CursorDirection getCursorDirection()

getCursor

public C getCursor()

asIterable

public PaginatedListIterable<E> asIterable()

asIterable

public PaginatedListIterable<E> asIterable(long timeout)

asIterable

public PaginatedListIterable<E> asIterable(long timeout,
                                           Backoff backoff)