Package api.equinix.javasdk.core.http.response

Class PaginatedList<T>

java.lang.Object

java.util.AbstractCollection<T>

java.util.AbstractList<T>

java.util.ArrayList<T>

api.equinix.javasdk.core.http.response.PaginatedList<T>

Type Parameters:

T - the type of resource in the list

All Implemented Interfaces:

Serializable, Cloneable, Iterable<T>, Collection<T>, List<T>, RandomAccess, SequencedCollection<T>

public class PaginatedList<T>
extends ArrayList<T>

A paginated list of resources returned by Equinix API list operations.

Extends ArrayList with pagination metadata and automatic page loading. All SDK list operations return this type (or PaginatedFilteredList for search operations). Provides methods to check for additional pages, load the next page, or eagerly load all pages.

Usage

 PaginatedList<Port> ports = fabric.ports().list();

 // Access pagination metadata
 Pagination pagination = ports.getPagination();
 int total = pagination.getTotal();
 boolean isLast = pagination.getIsLastPage();

 // Load additional pages
 while (ports.hasNextPage()) {
     ports.next();
 }

 // Or load all pages at once
 ports.loadAll();
 

Version:

$Id: $Id

Author:

ianjones

See Also:

• Pagination
• Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
PaginatedList(PaginatedList<T> initialItems, Pageable<T> pageableClient, EquinixRequest<T> equinixRequest, EquinixResponse<T> equinixResponse, Pagination pagination)	Constructor for PaginatedList.

Method Summary

Modifier and Type	Method	Description
boolean	hasNextPage()	Returns true if there are more pages of results available from the API.
PaginatedList<T>	loadAll()	Eagerly loads all remaining pages from the API, appending all results to this list.
void	next()	Loads the next page of results from the API and appends them to this list.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, addFirst, addLast, clear, clone, contains, ensureCapacity, equals, forEach, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll, reversed

Constructor Details

PaginatedList

public PaginatedList(PaginatedList<T> initialItems,
 Pageable<T> pageableClient,
 EquinixRequest<T> equinixRequest,
 EquinixResponse<T> equinixResponse,
 Pagination pagination)

Constructor for PaginatedList.

Parameters:

initialItems - a PaginatedList object.

pageableClient - a Pageable object.

equinixRequest - a EquinixRequest object.

equinixResponse - a EquinixResponse object.

pagination - a Pagination object.

Method Details

hasNextPage

public boolean hasNextPage()

Returns true if there are more pages of results available from the API.

Returns:

true if a next page exists; false if this is the last page

next

public void next()

Loads the next page of results from the API and appends them to this list. Does nothing if there are no more pages. After calling this method, the pagination metadata is updated to reflect the newly loaded page.

loadAll

public PaginatedList<T> loadAll()

Eagerly loads all remaining pages from the API, appending all results to this list. After calling this method, the list contains all available resources and hasNextPage() will return false.

Returns:

this list, now containing all resources across all pages