Package markets.alpaca.client.rest

Class AlpacaPagination

java.lang.Object

markets.alpaca.client.rest.AlpacaPagination

public final class AlpacaPagination
extends Object

Helpers for Alpaca REST endpoints that return a next_page_token.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AlpacaPagination.BrokerPageResponseFetcher<T>
static interface	AlpacaPagination.DataPageResponseFetcher<T>
static interface	AlpacaPagination.PageConsumer<T,E extends Exception>
static interface	AlpacaPagination.PageFetcher<T,E extends Exception>
static interface	AlpacaPagination.TradingPageResponseFetcher<T>

Method Summary

Modifier and Type	Method	Description
static <T> AlpacaPage<T>	brokerPage(ApiResponse<T> response, Function<? super T,String> nextPageTokenExtractor)	Adapts a Broker generated ApiResponse<T> into an AlpacaPage.
static <T, I> List<I>	collectBrokerItems(AlpacaPagination.BrokerPageResponseFetcher<T> fetcher, Function<? super T,String> nextPageTokenExtractor, Function<? super T,? extends Collection<? extends I>> itemExtractor)	Fetches all Broker pages and flattens each page body's items into one list.
static <T, I> List<I>	collectBrokerItems(AlpacaPagination.BrokerPageResponseFetcher<T> fetcher, Function<? super T,String> nextPageTokenExtractor, Function<? super T,? extends Collection<? extends I>> itemExtractor, AlpacaPaginationOptions options)	Fetches Broker pages and flattens items using pagination options.
static <T> List<AlpacaPage<T>>	collectBrokerPages(AlpacaPagination.BrokerPageResponseFetcher<T> fetcher, Function<? super T,String> nextPageTokenExtractor)	Fetches all Broker pages using a generated *WithHttpInfo call.
static <T> List<AlpacaPage<T>>	collectBrokerPages(AlpacaPagination.BrokerPageResponseFetcher<T> fetcher, Function<? super T,String> nextPageTokenExtractor, AlpacaPaginationOptions options)	Fetches Broker pages using a generated *WithHttpInfo call and options.
static <T, I> List<I>	collectDataItems(AlpacaPagination.DataPageResponseFetcher<T> fetcher, Function<? super T,String> nextPageTokenExtractor, Function<? super T,? extends Collection<? extends I>> itemExtractor)	Fetches all Market Data pages and flattens each page body's items into one list.
static <T, I> List<I>	collectDataItems(AlpacaPagination.DataPageResponseFetcher<T> fetcher, Function<? super T,String> nextPageTokenExtractor, Function<? super T,? extends Collection<? extends I>> itemExtractor, AlpacaPaginationOptions options)	Fetches Market Data pages and flattens items using pagination options.
static <T> List<AlpacaPage<T>>	collectDataPages(AlpacaPagination.DataPageResponseFetcher<T> fetcher, Function<? super T,String> nextPageTokenExtractor)	Fetches all Market Data pages using a generated *WithHttpInfo call.
static <T> List<AlpacaPage<T>>	collectDataPages(AlpacaPagination.DataPageResponseFetcher<T> fetcher, Function<? super T,String> nextPageTokenExtractor, AlpacaPaginationOptions options)	Fetches Market Data pages using a generated *WithHttpInfo call and options.
static <T, I, E extends Exception> List<I>	collectItems(AlpacaPagination.PageFetcher<T,E> fetcher, Function<? super T,? extends Collection<? extends I>> itemExtractor)	Fetches every page and flattens each page body's items into one list.
static <T, I, E extends Exception> List<I>	collectItems(AlpacaPagination.PageFetcher<T,E> fetcher, Function<? super T,? extends Collection<? extends I>> itemExtractor, AlpacaPaginationOptions options)	Fetches pages and flattens each page body's items into one list.
static <T, E extends Exception> List<AlpacaPage<T>>	collectPages(AlpacaPagination.PageFetcher<T,E> fetcher)	Fetches every page by passing each returned next-page token to fetcher.
static <T, E extends Exception> List<AlpacaPage<T>>	collectPages(AlpacaPagination.PageFetcher<T,E> fetcher, AlpacaPaginationOptions options)	Fetches pages by passing each returned next-page token to fetcher.
static <T, I> List<I>	collectTradingItems(AlpacaPagination.TradingPageResponseFetcher<T> fetcher, Function<? super T,String> nextPageTokenExtractor, Function<? super T,? extends Collection<? extends I>> itemExtractor)	Fetches all Trading pages and flattens each page body's items into one list.
static <T, I> List<I>	collectTradingItems(AlpacaPagination.TradingPageResponseFetcher<T> fetcher, Function<? super T,String> nextPageTokenExtractor, Function<? super T,? extends Collection<? extends I>> itemExtractor, AlpacaPaginationOptions options)	Fetches Trading pages and flattens items using pagination options.
static <T> List<AlpacaPage<T>>	collectTradingPages(AlpacaPagination.TradingPageResponseFetcher<T> fetcher, Function<? super T,String> nextPageTokenExtractor)	Fetches all Trading pages using a generated *WithHttpInfo call.
static <T> List<AlpacaPage<T>>	collectTradingPages(AlpacaPagination.TradingPageResponseFetcher<T> fetcher, Function<? super T,String> nextPageTokenExtractor, AlpacaPaginationOptions options)	Fetches Trading pages using a generated *WithHttpInfo call and options.
static <T> AlpacaPage<T>	dataPage(ApiResponse<T> response, Function<? super T,String> nextPageTokenExtractor)	Adapts a Market Data generated ApiResponse<T> into an AlpacaPage.
static <T, E extends Exception> void	forEachPage(AlpacaPagination.PageFetcher<T,E> fetcher, AlpacaPagination.PageConsumer<T,E> consumer)	Fetches every page and invokes consumer for each one.
static <T, E extends Exception> void	forEachPage(AlpacaPagination.PageFetcher<T,E> fetcher, AlpacaPagination.PageConsumer<T,E> consumer, AlpacaPaginationOptions options)	Fetches pages and invokes consumer for each one.
static <T> AlpacaPage<T>	page(AlpacaApiResponse<T> response, Function<? super T,String> nextPageTokenExtractor)	Adapts an AlpacaApiResponse and body token extractor into an AlpacaPage.
static <T> AlpacaPage<T>	tradingPage(ApiResponse<T> response, Function<? super T,String> nextPageTokenExtractor)	Adapts a Trading generated ApiResponse<T> into an AlpacaPage.

Methods inherited from class java.lang.Object

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

Method Details

page

public static <T> AlpacaPage<T> page(AlpacaApiResponse<T> response,
 Function<? super T,String> nextPageTokenExtractor)

Adapts an AlpacaApiResponse and body token extractor into an AlpacaPage.

brokerPage

public static <T> AlpacaPage<T> brokerPage(ApiResponse<T> response,
 Function<? super T,String> nextPageTokenExtractor)

Adapts a Broker generated ApiResponse<T> into an AlpacaPage.

dataPage

public static <T> AlpacaPage<T> dataPage(ApiResponse<T> response,
 Function<? super T,String> nextPageTokenExtractor)

Adapts a Market Data generated ApiResponse<T> into an AlpacaPage.

tradingPage

public static <T> AlpacaPage<T> tradingPage(ApiResponse<T> response,
 Function<? super T,String> nextPageTokenExtractor)

Adapts a Trading generated ApiResponse<T> into an AlpacaPage.

collectPages

public static <T,
E extends Exception>
List<AlpacaPage<T>> collectPages(AlpacaPagination.PageFetcher<T,E> fetcher)
                          throws E

Fetches every page by passing each returned next-page token to fetcher.

Throws:

E extends Exception

collectPages

public static <T,
E extends Exception>
List<AlpacaPage<T>> collectPages(AlpacaPagination.PageFetcher<T,E> fetcher,
 AlpacaPaginationOptions options)
                          throws E

Fetches pages by passing each returned next-page token to fetcher.

Throws:

E extends Exception

forEachPage

public static <T,
E extends Exception> void forEachPage(AlpacaPagination.PageFetcher<T,E> fetcher,
 AlpacaPagination.PageConsumer<T,E> consumer)
                                                throws E

Fetches every page and invokes consumer for each one.

Throws:

E extends Exception

forEachPage

public static <T,
E extends Exception> void forEachPage(AlpacaPagination.PageFetcher<T,E> fetcher,
 AlpacaPagination.PageConsumer<T,E> consumer,
 AlpacaPaginationOptions options)
                                                throws E

Fetches pages and invokes consumer for each one.

Throws:

E extends Exception

collectItems

public static <T,
I,
E extends Exception> List<I> collectItems(AlpacaPagination.PageFetcher<T,E> fetcher,
 Function<? super T,? extends Collection<? extends I>> itemExtractor)
                                                      throws E

Fetches every page and flattens each page body's items into one list.

Throws:

E extends Exception

collectItems

public static <T,
I,
E extends Exception> List<I> collectItems(AlpacaPagination.PageFetcher<T,E> fetcher,
 Function<? super T,? extends Collection<? extends I>> itemExtractor,
 AlpacaPaginationOptions options)
                                                      throws E

Fetches pages and flattens each page body's items into one list.

Throws:

E extends Exception

collectBrokerPages

public static <T> List<AlpacaPage<T>> collectBrokerPages(AlpacaPagination.BrokerPageResponseFetcher<T> fetcher,
 Function<? super T,String> nextPageTokenExtractor)
                                                  throws ApiException

Fetches all Broker pages using a generated *WithHttpInfo call.

Throws:

ApiException

collectBrokerPages

public static <T> List<AlpacaPage<T>> collectBrokerPages(AlpacaPagination.BrokerPageResponseFetcher<T> fetcher,
 Function<? super T,String> nextPageTokenExtractor,
 AlpacaPaginationOptions options)
                                                  throws ApiException

Fetches Broker pages using a generated *WithHttpInfo call and options.

Throws:

ApiException

collectDataPages

public static <T> List<AlpacaPage<T>> collectDataPages(AlpacaPagination.DataPageResponseFetcher<T> fetcher,
 Function<? super T,String> nextPageTokenExtractor)
                                                throws ApiException

Fetches all Market Data pages using a generated *WithHttpInfo call.

Throws:

ApiException

collectDataPages

public static <T> List<AlpacaPage<T>> collectDataPages(AlpacaPagination.DataPageResponseFetcher<T> fetcher,
 Function<? super T,String> nextPageTokenExtractor,
 AlpacaPaginationOptions options)
                                                throws ApiException

Fetches Market Data pages using a generated *WithHttpInfo call and options.

Throws:

ApiException

collectTradingPages

public static <T> List<AlpacaPage<T>> collectTradingPages(AlpacaPagination.TradingPageResponseFetcher<T> fetcher,
 Function<? super T,String> nextPageTokenExtractor)
                                                   throws ApiException

Fetches all Trading pages using a generated *WithHttpInfo call.

Throws:

ApiException

collectTradingPages

public static <T> List<AlpacaPage<T>> collectTradingPages(AlpacaPagination.TradingPageResponseFetcher<T> fetcher,
 Function<? super T,String> nextPageTokenExtractor,
 AlpacaPaginationOptions options)
                                                   throws ApiException

Fetches Trading pages using a generated *WithHttpInfo call and options.

Throws:

ApiException

collectBrokerItems

public static <T,
I> List<I> collectBrokerItems(AlpacaPagination.BrokerPageResponseFetcher<T> fetcher,
 Function<? super T,String> nextPageTokenExtractor,
 Function<? super T,? extends Collection<? extends I>> itemExtractor)
                                        throws ApiException

Fetches all Broker pages and flattens each page body's items into one list.

Throws:

ApiException

collectBrokerItems

public static <T,
I> List<I> collectBrokerItems(AlpacaPagination.BrokerPageResponseFetcher<T> fetcher,
 Function<? super T,String> nextPageTokenExtractor,
 Function<? super T,? extends Collection<? extends I>> itemExtractor,
 AlpacaPaginationOptions options)
                                        throws ApiException

Fetches Broker pages and flattens items using pagination options.

Throws:

ApiException

collectDataItems

public static <T,
I> List<I> collectDataItems(AlpacaPagination.DataPageResponseFetcher<T> fetcher,
 Function<? super T,String> nextPageTokenExtractor,
 Function<? super T,? extends Collection<? extends I>> itemExtractor)
                                      throws ApiException

Fetches all Market Data pages and flattens each page body's items into one list.

Throws:

ApiException

collectDataItems

public static <T,
I> List<I> collectDataItems(AlpacaPagination.DataPageResponseFetcher<T> fetcher,
 Function<? super T,String> nextPageTokenExtractor,
 Function<? super T,? extends Collection<? extends I>> itemExtractor,
 AlpacaPaginationOptions options)
                                      throws ApiException

Fetches Market Data pages and flattens items using pagination options.

Throws:

ApiException

collectTradingItems

public static <T,
I> List<I> collectTradingItems(AlpacaPagination.TradingPageResponseFetcher<T> fetcher,
 Function<? super T,String> nextPageTokenExtractor,
 Function<? super T,? extends Collection<? extends I>> itemExtractor)
                                         throws ApiException

Fetches all Trading pages and flattens each page body's items into one list.

Throws:

ApiException

collectTradingItems

public static <T,
I> List<I> collectTradingItems(AlpacaPagination.TradingPageResponseFetcher<T> fetcher,
 Function<? super T,String> nextPageTokenExtractor,
 Function<? super T,? extends Collection<? extends I>> itemExtractor,
 AlpacaPaginationOptions options)
                                         throws ApiException

Fetches Trading pages and flattens items using pagination options.

Throws:

ApiException