com.azure.core.http.rest

Class PagedIterableBase<T,P extends PagedResponse<T>>

java.lang.Object

com.azure.core.util.IterableStream<T>

com.azure.core.http.rest.PagedIterableBase<T,P>

Type Parameters:

T - The type of value contained in this IterableStream.

P - The response extending from PagedResponse

All Implemented Interfaces:

Iterable<T>

Direct Known Subclasses:

PagedIterable

public class PagedIterableBase<T,P extends PagedResponse<T>>
extends IterableStream<T>

This class provides utility to iterate over responses that extend PagedResponse using Stream and Iterable interfaces.

Code sample using Stream by page

// process the streamByPage
CustomPagedFlux<String> customPagedFlux = createCustomInstance();
PagedIterableBase<String, PagedResponse<String>> customPagedIterableResponse =
    new PagedIterableBase<>(customPagedFlux);
customPagedIterableResponse.streamByPage().forEach(resp -> {
    System.out.printf("Response headers are %s. Url %s  and status code %d %n", resp.getHeaders(),
        resp.getRequest().getUrl(), resp.getStatusCode());
    resp.getItems().forEach(value -> {
        System.out.printf("Response value is %s %n", value);
    });
});

Code sample using Iterable by page

// process the iterableByPage
customPagedIterableResponse.iterableByPage().forEach(resp -> {
    System.out.printf("Response headers are %s. Url %s  and status code %d %n", resp.getHeaders(),
        resp.getRequest().getUrl(), resp.getStatusCode());
    resp.getItems().forEach(value -> {
        System.out.printf("Response value is %s %n", value);
    });
});

Code sample using Iterable by page and while loop

// iterate over each page
Iterator<PagedResponse<String>> iterator = customPagedIterableResponse.iterableByPage().iterator();
while (iterator.hasNext()) {
    PagedResponse<String> resp = iterator.next();
    System.out.printf("Response headers are %s. Url %s  and status code %d %n", resp.getHeaders(),
        resp.getRequest().getUrl(), resp.getStatusCode());
    resp.getItems().forEach(value -> {
        System.out.printf("Response value is %s %n", value);
    });
}

See Also:

PagedResponse, IterableStream

Constructor Summary

Constructors

Constructor and Description
PagedIterableBase(PagedFluxBase<T,P> pagedFluxBase) Creates instance given PagedFluxBase.

Method Summary

Modifier and Type	Method and Description
Iterable<P>	iterableByPage() Provides Iterable API for{ @link PagedResponse} It will provide same collection of T values from starting if called multiple times.
Iterable<P>	iterableByPage(String continuationToken) Provides Iterable API for PagedResponse, starting from the next page associated with the given continuation token.
Stream<P>	streamByPage() Retrieve the Stream, one page at a time.
Stream<P>	streamByPage(String continuationToken) Retrieve the Stream, one page at a time, starting from the next page associated with the given continuation token.

Methods inherited from class com.azure.core.util.IterableStream

iterator, stream

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

PagedIterableBase

public PagedIterableBase(PagedFluxBase<T,P> pagedFluxBase)

Creates instance given PagedFluxBase.

Parameters:

pagedFluxBase - to use as iterable

Method Detail

streamByPage

public Stream<P> streamByPage()

Retrieve the Stream, one page at a time. It will provide same Stream of T values from starting if called multiple times.

Returns:

Stream of a Response that extends PagedResponse

streamByPage

public Stream<P> streamByPage(String continuationToken)

Retrieve the Stream, one page at a time, starting from the next page associated with the given continuation token. To start from first page, use PagedIterableBase.streamByPage() instead.

Parameters:

continuationToken - The continuation token used to fetch the next page

Returns:

Stream of a Response that extends PagedResponse, starting from the page associated with the continuation token

iterableByPage

public Iterable<P> iterableByPage()

Provides Iterable API for{ @link PagedResponse} It will provide same collection of T values from starting if called multiple times.

Returns:

Iterable interface

iterableByPage

public Iterable<P> iterableByPage(String continuationToken)

Provides Iterable API for PagedResponse, starting from the next page associated with the given continuation token. To start from first page, use PagedIterableBase.streamByPage() instead. It will provide same collection of T values from starting if called multiple times.

Parameters:

continuationToken - The continuation token used to fetch the next page

Returns:

Iterable interface