A CloseableIterable that supports pagination while traversing a repository or incremental
changes. An implementation can optionally break a large traversal process into smaller pieces,
using checkpoints to track progress, and returning true from hasMore() to indicate more objects are available.
Performs any actions necessary to stop accessing the repository, such as closing the
connection.
From interface
java.lang.Iterable
void
forEach(Consumer<? super T> arg0)
abstract
Iterator<T>
iterator()
Spliterator<T>
spliterator()
From interface
java.lang.AutoCloseable
abstract
void
close()
Public Methods
public
abstract
byte[]
getCheckpoint()
Get current checkpoint value. Framework is expected to call this method only after iterating
through all objects available.
Returns
checkpoint value to save
Throws
RuntimeException
if computation of checkpoint value fails.
public
abstract
boolean
hasMore()
Flag to indicate if more items are available to traverse beyond current set of items returned
as part of Iterable. Framework is expected to call this method only after iterating
through all objects available.
Returns
True if more objects are available for processing after current batch. False if no more
objects available for traversal.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-03 UTC."],[[["`CheckpointCloseableIterable` enables pagination and supports breaking large traversals into smaller pieces using checkpoints."],["It extends `CloseableIterable` and provides methods to get the current checkpoint and check for more items."],["`getCheckpoint()` returns the current checkpoint value for tracking progress."],["`hasMore()` indicates if more items are available beyond the current set."],["Implementations can use checkpoints to resume traversal from a previous point."]]],[]]