Module methanol

Package com.github.mizosoft.methanol

Class ProgressTracker

java.lang.Object

com.github.mizosoft.methanol.ProgressTracker

public final class ProgressTracker
extends Object

A progress tracker for upload and download operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ProgressTracker.Builder	A builder of ProgressTrackers.
static interface	ProgressTracker.Listener	A listener of progress events.
static interface	ProgressTracker.MultipartListener	A ProgressTracker.Listener of multipart progress events.
static interface	ProgressTracker.MultipartProgress	A progress event for a multipart body with per-part progress info.
static interface	ProgressTracker.Progress	A progress event.

Method Summary

Modifier and Type	Method	Description
long	bytesTransferredThreshold()	Returns the minimum number of bytes to be transferred for a progress event to be signalled.
static ProgressTracker	create()	Returns a default ProgressTracker with no thresholds or executor.
boolean	enclosedProgress()	Returns whether the sequence of progress events is enclosed between 0% and 100% progress events.
Optional<Executor>	executor()	Returns the optional executor on which ProgressTracker.Listener methods are called.
static ProgressTracker.Builder	newBuilder()	Returns a new ProgressTracker.Builder.
Optional<Duration>	timePassedThreshold()	Returns the minimum time to pass for a progress event to be signalled.
HttpRequest.BodyPublisher	tracking(HttpRequest.BodyPublisher upstream, ProgressTracker.Listener listener)	Returns a BodyPublisher that tracks the given BodyPublisher's upload progress.
<T> HttpResponse.BodyHandler<T>	tracking(HttpResponse.BodyHandler<T> handler, ProgressTracker.Listener listener)	Returns a BodyHandler that tracks the download progress of the BodySubscriber returned by the given handler.
<T> HttpResponse.BodySubscriber<T>	tracking(HttpResponse.BodySubscriber<T> downstream, ProgressTracker.Listener listener, long contentLengthIfKnown)	Returns a BodySubscriber that tracks the given BodySubscriber's download progress.
MimeBodyPublisher	trackingMultipart(MultipartBodyPublisher upstream, ProgressTracker.MultipartListener listener)	Returns a BodyPublisher that tracks the given MultipartBodyPublisher's upload progress with per-part progress events.

Methods inherited from class java.lang.Object

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

Method Details

bytesTransferredThreshold

public long bytesTransferredThreshold()

Returns the minimum number of bytes to be transferred for a progress event to be signalled.

timePassedThreshold

public Optional<Duration> timePassedThreshold()

Returns the minimum time to pass for a progress event to be signalled.

enclosedProgress

public boolean enclosedProgress()

Returns whether the sequence of progress events is enclosed between 0% and 100% progress events.

executor

public Optional<Executor> executor()

Returns the optional executor on which ProgressTracker.Listener methods are called.

tracking

public HttpRequest.BodyPublisher tracking(HttpRequest.BodyPublisher upstream,
 ProgressTracker.Listener listener)

Returns a BodyPublisher that tracks the given BodyPublisher's upload progress.

trackingMultipart

public MimeBodyPublisher trackingMultipart(MultipartBodyPublisher upstream,
 ProgressTracker.MultipartListener listener)

Returns a BodyPublisher that tracks the given MultipartBodyPublisher's upload progress with per-part progress events.

tracking

public <T> HttpResponse.BodySubscriber<T> tracking(HttpResponse.BodySubscriber<T> downstream,
 ProgressTracker.Listener listener,
 long contentLengthIfKnown)

Returns a BodySubscriber that tracks the given BodySubscriber's download progress. contentLengthIfKnown is the total length of downloaded content or a negative value if unknown.

tracking

public <T> HttpResponse.BodyHandler<T> tracking(HttpResponse.BodyHandler<T> handler,
 ProgressTracker.Listener listener)

Returns a BodyHandler that tracks the download progress of the BodySubscriber returned by the given handler.

create

public static ProgressTracker create()

Returns a default ProgressTracker with no thresholds or executor.

newBuilder

public static ProgressTracker.Builder newBuilder()

Returns a new ProgressTracker.Builder.