com.stripe.model.StripeCollectionAPIResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stripe-java Show documentation

Stripe Java Bindings

There is a newer version: 9.5.0

package com.stripe.model;

import com.stripe.net.APIResource;
import com.stripe.net.RequestOptions;

import java.util.Iterator;
import java.util.List;
import java.util.Map;

public abstract class StripeCollectionAPIResource extends APIResource implements StripeCollectionInterface {
	List data;
	Boolean hasMore;
	Integer totalCount;
	String url;

	/** 3/2014: Legacy (from before newstyle pagination API) */
	Integer count;

	private RequestOptions requestOptions;
	private Map requestParams;

	public List getData() {
		return data;
	}

	public void setData(List data) {
		this.data = data;
	}

	public Boolean getHasMore() {
		return hasMore;
	}

	public void setHasMore(Boolean hasMore) {
		this.hasMore = hasMore;
	}

	public Integer getTotalCount() {
		return totalCount;
	}

	public void setTotalCount(Integer totalCount) {
		this.totalCount = totalCount;
	}

	public String getURL() {
		return url;
	}

	public void setURL(String url) {
		this.url = url;
	}

	/** 3/2014: Legacy (from before newstyle pagination API) */
	public Integer getCount() {
		return count;
	}

	/** 3/2014: Legacy (from before newstyle pagination API) */
	public void setCount(Integer count) {
		this.count = count;
	}

	/**
	 * 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.
	 */
	public Iterable autoPagingIterable() {
		return autoPagingIterable(null, null);
	}

	public Iterable autoPagingIterable(Map params) {
		return autoPagingIterable(params, null);
	}

	public Iterable autoPagingIterable(Map params, RequestOptions options) {
		// This does have the side effect of manipulating the state of the
		// given collection, which is an unfortunate side effect, but is quite
		// likely a good practical trade-off in that these should only be used
		// for auto pagination with that particular collection instance.
		this.setRequestOptions(options);
		this.setRequestParams(params);

		return new PagingIterable(this);
	}

	public RequestOptions getRequestOptions() {
		return this.requestOptions;
	}

	public Map getRequestParams() {
		return this.requestParams;
	}

	public void setRequestOptions(RequestOptions requestOptions) {
		this.requestOptions = requestOptions;
	}

	public void setRequestParams(Map requestParams) {
		this.requestParams = requestParams;
	}
}