com.ibm.cloud.objectstorage.services.s3.transfer

Class TransferProgress

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.transfer.TransferProgress

public final class TransferProgress
extends Object

Describes the progress of a transfer.

Constructor Summary

Constructors

Constructor and Description
TransferProgress()

Method Summary

Modifier and Type	Method and Description
long	getBytesTransfered() Deprecated. Replaced by TransferProgress.getBytesTransferred()
long	getBytesTransferred() Returns the number of bytes completed in the associated transfer.
double	getPercentTransfered() Deprecated. Replaced by TransferProgress.getPercentTransferred()
double	getPercentTransferred() Returns a percentage of the number of bytes transferred out of the total number of bytes to transfer.
long	getTotalBytesToTransfer() Returns the total size in bytes of the associated transfer, or -1 if the total size isn't known.
void	setTotalBytesToTransfer(long totalBytesToTransfer)
void	updateProgress(long bytes)

Methods inherited from class java.lang.Object

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

Constructor Detail

TransferProgress

public TransferProgress()

Method Detail

getBytesTransfered

public long getBytesTransfered()

Deprecated. Replaced by TransferProgress.getBytesTransferred()

getBytesTransferred

public long getBytesTransferred()

Returns the number of bytes completed in the associated transfer.

Returns:

The number of bytes completed in the associated transfer.

getTotalBytesToTransfer

public long getTotalBytesToTransfer()

Returns the total size in bytes of the associated transfer, or -1 if the total size isn't known.

Returns:

The total size in bytes of the associated transfer. Returns or -1 if the total size of the associated transfer isn't known yet.

getPercentTransfered

@Deprecated
public double getPercentTransfered()

Deprecated. Replaced by TransferProgress.getPercentTransferred()

getPercentTransferred

public double getPercentTransferred()

Returns a percentage of the number of bytes transferred out of the total number of bytes to transfer.

Returns:

A percentage of the number of bytes transferred out of the total number of bytes to transfer; or -1.0 if the total length is not known.

updateProgress

public void updateProgress(long bytes)

setTotalBytesToTransfer

public void setTotalBytesToTransfer(long totalBytesToTransfer)