Package org.projectnessie.client

Class StreamingUtil

java.lang.Object

org.projectnessie.client.StreamingUtil

public final class StreamingUtil
extends Object

Helper and utility methods around streaming of TreeApi et al.

Method Summary

Modifier and Type	Method	Description
static Stream<CommitMeta>	getCommitLogStream(@NotNull TreeApi treeApi, @NotNull String ref, OptionalInt pageSizeHint)	Default implementation to return a stream of commit-log entries, functionally equivalent to calling TreeApi.getCommitLog(String, Integer, String) with manual paging.
static Stream<EntriesResponse.Entry>	getEntriesStream(@NotNull TreeApi treeApi, @NotNull String ref, OptionalInt pageSizeHint, List<String> types)	Default implementation to return a stream of objects for a ref, functionally equivalent to calling TreeApi.getEntries(String, Integer, String, List) with manual paging.

Methods inherited from class java.lang.Object

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

Method Detail

getEntriesStream

public static Stream<EntriesResponse.Entry> getEntriesStream(@NotNull
                                                             @NotNull TreeApi treeApi,
                                                             @NotNull
                                                             @NotNull String ref,
                                                             OptionalInt pageSizeHint,
                                                             List<String> types)
                                                      throws NessieNotFoundException

Default implementation to return a stream of objects for a ref, functionally equivalent to calling TreeApi.getEntries(String, Integer, String, List) with manual paging.

The Stream returned by getEntriesStream(ref, OptionalInt.empty()), if not limited, returns all commit-log entries.

Parameters:

ref - a named reference (branch or tag name) or a commit-hash

pageSizeHint - page-size hint for the backend

types - types to filter on. Empty list means no filtering.

Returns:

stream of EntriesResponse.Entry objects

Throws:

NessieNotFoundException

getCommitLogStream

public static Stream<CommitMeta> getCommitLogStream(@NotNull
                                                    @NotNull TreeApi treeApi,
                                                    @NotNull
                                                    @NotNull String ref,
                                                    OptionalInt pageSizeHint)
                                             throws NessieNotFoundException

Default implementation to return a stream of commit-log entries, functionally equivalent to calling TreeApi.getCommitLog(String, Integer, String) with manual paging.

The Stream returned by getCommitLogStream(ref, OptionalInt.empty()), if not limited, returns all commit-log entries.

Parameters:

ref - a named reference (branch or tag name) or a commit-hash

pageSizeHint - page-size hint for the backend

Returns:

stream of CommitMeta objects

Throws:

NessieNotFoundException