com.ibm.cloud.objectstorage.event.request

Class Progress

java.lang.Object

com.ibm.cloud.objectstorage.event.request.Progress

Direct Known Subclasses:

ProgressSupport

@ThreadSafe
public class Progress
extends Object

Base class used to represent the progress of a logical request/response, which may correspond to either be a physical http request/response, or multiple requests/responses as in a composite operation such as multi-part uploads.

See Also:

ProgressSupport

Field Summary

Fields

Modifier and Type	Field and Description
static Progress	NOOP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Progress()

Method Summary

Modifier and Type	Method and Description
void	addRequestBytesTransferred(long bytes)
void	addRequestContentLength(long contentLength)
void	addResponseBytesTransferred(long bytes)
void	addResponseContentLength(long contentLength)
long	getRequestBytesTransferred()
long	getRequestContentLength()
long	getResponseBytesTransferred()
long	getResponseContentLength()
boolean	isEnabled() Returns true if progress tracking is enabled; false otherwise.

Methods inherited from class java.lang.Object

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

Field Detail

NOOP

public static final Progress NOOP

Constructor Detail

Progress

protected Progress()

Method Detail

isEnabled

public boolean isEnabled()

Returns true if progress tracking is enabled; false otherwise.

addRequestBytesTransferred

public void addRequestBytesTransferred(long bytes)

Parameters:

bytes - can be negative if it was a reset event.

addResponseBytesTransferred

public void addResponseBytesTransferred(long bytes)

Parameters:

bytes - can be negative if it was a reset event.

getRequestContentLength

public long getRequestContentLength()

addRequestContentLength

public void addRequestContentLength(long contentLength)

getRequestBytesTransferred

public long getRequestBytesTransferred()

getResponseContentLength

public long getResponseContentLength()

addResponseContentLength

public void addResponseContentLength(long contentLength)

getResponseBytesTransferred

public long getResponseBytesTransferred()