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 NessieApiV1 et al.

Method Summary

Modifier and Type	Method	Description
static Stream<Reference>	getAllReferencesStream(@NotNull NessieApiV1 api, OptionalInt maxRecords, String queryExpression)	Default implementation to return a stream of references, functionally equivalent to calling NessieApiV1.getAllReferences() with manual paging.
static Stream<LogResponse.LogEntry>	getCommitLogStream(@NotNull NessieApiV1 api, @NotNull String ref, String hashOnRef, String untilHash, String queryExpression, OptionalInt maxRecords)	Default implementation to return a stream of commit-log entries, functionally equivalent to calling NessieApiV1.getCommitLog() with manual paging.
static Stream<EntriesResponse.Entry>	getEntriesStream(@NotNull NessieApiV1 api, @NotNull String ref, String hashOnRef, String queryExpression, OptionalInt maxRecords)	Default implementation to return a stream of objects for a ref, functionally equivalent to calling NessieApiV1.getEntries() with manual paging.

Methods inherited from class java.lang.Object

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

Method Detail

getAllReferencesStream

public static Stream<Reference> getAllReferencesStream(@NotNull
                                                       @NotNull NessieApiV1 api,
                                                       OptionalInt maxRecords,
                                                       @Nullable
                                                       String queryExpression)
                                                throws NessieNotFoundException

Default implementation to return a stream of references, functionally equivalent to calling NessieApiV1.getAllReferences() with manual paging.

Returns:

stream of Reference objects

Throws:

NessieNotFoundException

getEntriesStream

public static Stream<EntriesResponse.Entry> getEntriesStream(@NotNull
                                                             @NotNull NessieApiV1 api,
                                                             @NotNull
                                                             @NotNull String ref,
                                                             @Nullable
                                                             String hashOnRef,
                                                             @Nullable
                                                             String queryExpression,
                                                             OptionalInt maxRecords)
                                                      throws NessieNotFoundException

Default implementation to return a stream of objects for a ref, functionally equivalent to calling NessieApiV1.getEntries() 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

Returns:

stream of EntriesResponse.Entry objects

Throws:

NessieNotFoundException

getCommitLogStream

public static Stream<LogResponse.LogEntry> getCommitLogStream(@NotNull
                                                              @NotNull NessieApiV1 api,
                                                              @NotNull
                                                              @NotNull String ref,
                                                              @Nullable
                                                              String hashOnRef,
                                                              @Nullable
                                                              String untilHash,
                                                              @Nullable
                                                              String queryExpression,
                                                              OptionalInt maxRecords)
                                                       throws NessieNotFoundException

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

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

Parameters:

api - The NessieApiV1 to use

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

Returns:

stream of CommitMeta objects

Throws:

NessieNotFoundException