com.stripe.model

Class StripeCollection<T extends HasId>

java.lang.Object

com.stripe.model.StripeObject

com.stripe.model.StripeCollection<T>

All Implemented Interfaces:

StripeCollectionInterface<T>

Direct Known Subclasses:

AccountCollection, ApplePayDomainCollection, ApplicationFeeCollection, BalanceTransactionCollection, BitcoinReceiverCollection, BitcoinTransactionCollection, ChargeCollection, ChargeRefundCollection, CountrySpecCollection, CouponCollection, CustomerCardCollection, CustomerCollection, CustomerSubscriptionCollection, DisputeCollection, EventCollection, ExchangeRateCollection, ExternalAccountCollection, FeeRefundCollection, FileUploadCollection, InvoiceCollection, InvoiceItemCollection, InvoiceLineItemCollection, LoginLinkCollection, OrderCollection, OrderReturnCollection, PayoutCollection, PlanCollection, ProductCollection, RecipientCardCollection, RecipientCollection, RefundCollection, SKUCollection, SourceTransactionCollection, SubscriptionCollection, SubscriptionItemCollection, TransferCollection, TransferReversalCollection, TransferTransactionCollection

public abstract class StripeCollection<T extends HasId>
extends StripeObject
implements StripeCollectionInterface<T>

Provides a representation of a single page worth of data from the Stripe API.

The following code will have the effect of iterating through a single page worth of invoice data retrieve from the API:

 
 foreach (Invoice invoice : Invoice.list(...).getData()) {
 	 System.out.println("Current invoice = " + invoice.toString());
 }
 
 

The class also provides a helper for iterating over collections that may be longer than a single page:

 
 foreach (Invoice invoice : Invoice.list(...).autoPagingIterable()) {
 	 System.out.println("Current invoice = " + invoice.toString());
 }
 
 

Field Summary

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor and Description
StripeCollection()

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<T>	autoPagingIterable() Returns an iterable that can be used to iterate across all objects across all pages.
java.lang.Integer	getCount() 3/2014: Legacy (from before newstyle pagination API)
java.util.List<T>	getData()
java.lang.Boolean	getHasMore()
RequestOptions	getRequestOptions() Get request options that were used to fetch the collection.
java.util.Map<java.lang.String,java.lang.Object>	getRequestParams() Get request parameters that were used to fetch the collection.
java.lang.Integer	getTotalCount()
java.lang.String	getURL()
void	setCount(java.lang.Integer count) 3/2014: Legacy (from before newstyle pagination API)
void	setData(java.util.List<T> data)
void	setHasMore(java.lang.Boolean hasMore)
void	setRequestOptions(RequestOptions requestOptions) Set request options that were used to fetch the collection.
void	setRequestParams(java.util.Map<java.lang.String,java.lang.Object> requestParams) Set request parameters that were used to fetch the collection.
void	setTotalCount(java.lang.Integer totalCount)
void	setURL(java.lang.String url)

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StripeCollection

public StripeCollection()

Method Detail

getData

public java.util.List<T> getData()

Specified by:

getData in interface StripeCollectionInterface<T extends HasId>

setData

public void setData(java.util.List<T> data)

getTotalCount

public java.lang.Integer getTotalCount()

Specified by:

getTotalCount in interface StripeCollectionInterface<T extends HasId>

setTotalCount

public void setTotalCount(java.lang.Integer totalCount)

getHasMore

public java.lang.Boolean getHasMore()

Specified by:

getHasMore in interface StripeCollectionInterface<T extends HasId>

setHasMore

public void setHasMore(java.lang.Boolean hasMore)

getURL

public java.lang.String getURL()

Specified by:

getURL in interface StripeCollectionInterface<T extends HasId>

setURL

public void setURL(java.lang.String url)

getCount

public java.lang.Integer getCount()

3/2014: Legacy (from before newstyle pagination API)

setCount

public void setCount(java.lang.Integer count)

3/2014: Legacy (from before newstyle pagination API)

autoPagingIterable

public java.lang.Iterable<T> autoPagingIterable()

Returns an iterable that can be used to iterate across all objects across all pages. As page boundaries are encountered, the next page will be fetched automatically for continued iteration.

getRequestOptions

public RequestOptions getRequestOptions()

Description copied from interface: StripeCollectionInterface

Get request options that were used to fetch the collection. This is useful for purposes of pagination.

Specified by:

getRequestOptions in interface StripeCollectionInterface<T extends HasId>

getRequestParams

public java.util.Map<java.lang.String,java.lang.Object> getRequestParams()

Description copied from interface: StripeCollectionInterface

Get request parameters that were used to fetch the collection. This is useful for purposes of pagination.

Specified by:

getRequestParams in interface StripeCollectionInterface<T extends HasId>

setRequestOptions

public void setRequestOptions(RequestOptions requestOptions)

Description copied from interface: StripeCollectionInterface

Set request options that were used to fetch the collection. This is required for purposes of pagination.

Specified by:

setRequestOptions in interface StripeCollectionInterface<T extends HasId>

setRequestParams

public void setRequestParams(java.util.Map<java.lang.String,java.lang.Object> requestParams)

Description copied from interface: StripeCollectionInterface

Set request parameters that were used to fetch the collection. This is required for purposes of pagination.

Specified by:

setRequestParams in interface StripeCollectionInterface<T extends HasId>