li.netcat.smartsync
Class TransferProgress

java.lang.Object
  |
  +--li.netcat.smartsync.TransferProgress

public class TransferProgress

extends java.lang.Object

Immutable class that represents the current transfer progress of the synchronization. Negative values of properties must be interpreted as unknown.

Author:

Arthur Marxer

Constructor Summary

TransferProgress(int totalFiles, int completedFiles, long totalTraffic, long completedTraffic, long transferRate, int remainingTime)
Constructs and initializes a new instance of a TransferProgress object.

Method Summary

int	getCompletedFiles() Returns the number of completed files that caused network traffic.
long	getCompletedTraffic() Returns the completed traffic in byte.
float	getProgress() Returns the overall progress
int	getRemainingFiles() Returns the number of remaining files that will cause network traffic.
int	getRemainingTime() Returns the estimated remaining time to complete all tasks measured in sec.
long	getRemainingTraffic() Returns the remining traffic in byte.
int	getTotalFiles() Returns the total number of files that cause network traffic.
long	getTotalTraffic() Returns the total amount of traffic in byte.
long	getTransferRate() Returns the estimated transferrate measured in bit/s.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransferProgress

public TransferProgress(int totalFiles,
                        int completedFiles,
                        long totalTraffic,
                        long completedTraffic,
                        long transferRate,
                        int remainingTime)

Constructs and initializes a new instance of a TransferProgress object.

Parameters:

totalFiles - The total number of files that cause network traffic.

completedFiles - The number of completed files that caused network traffic.

totalTraffic - The total amount of traffic in byte.

completedTraffic - The completed traffic in byte.

transferRate - The estimated transferrate measured in bit/s.

remainingTime - The estimated remaining time to complete all tasks measured in sec.

Method Detail

getTotalFiles

public int getTotalFiles()

Returns the total number of files that cause network traffic.

Returns:

The total number of files that cause network traffic.

getCompletedFiles

public int getCompletedFiles()

Returns the number of completed files that caused network traffic.

Returns:

The number of completed files that caused network traffic.

getRemainingFiles

public int getRemainingFiles()

Returns the number of remaining files that will cause network traffic.

Returns:

The number of remaining files that will cause network traffic.

getTotalTraffic

public long getTotalTraffic()

Returns the total amount of traffic in byte.

Returns:

The total amount of traffic in byte.

getCompletedTraffic

public long getCompletedTraffic()

Returns the completed traffic in byte.

Returns:

The completed traffic in byte.

getRemainingTraffic

public long getRemainingTraffic()

Returns the remining traffic in byte.

Returns:

The remining traffic in byte.

getTransferRate

public long getTransferRate()

Returns the estimated transferrate measured in bit/s.

Returns:

The estimated transferrate measured in bit/s.

getRemainingTime

public int getRemainingTime()

Returns the estimated remaining time to complete all tasks measured in sec.

Returns:

The estimated remaining time to complete all tasks measured in sec.

getProgress

public float getProgress()

Returns the overall progress

Returns:

A value >= 0.0f and <= 1.0f.