eu.unicore.hila.grid
Interface Progressable

public interface Progressable

The Progressable interface allows a user to monitor progress, i.e. how far a File ThirdPartyTransfer has progressed. This interface exists to generate human-readable information, i.e. "36/42 bytes" transferred.

Author:

bjoernh 12.03.2010 15:22:47

Method Summary

long	getCurrent()
long	getMax()
String	getUnit() A human-readable String describing the unit of the progress, e.g.
boolean	isDone()

Method Detail

getUnit

String getUnit()
               throws eu.unicore.hila.exceptions.HiLAException

A human-readable String describing the unit of the progress, e.g. "bytes"

Returns:

A unit String

Throws:

eu.unicore.hila.exceptions.HiLAException

getMax

long getMax()
            throws eu.unicore.hila.exceptions.HiLAException

Returns:

The maximum value.

Throws:

eu.unicore.hila.exceptions.HiLAException

getCurrent

long getCurrent()
                throws eu.unicore.hila.exceptions.HiLAException

Returns:

The current value, i.e. progress.

Throws:

eu.unicore.hila.exceptions.HiLAException

isDone

boolean isDone()
               throws eu.unicore.hila.exceptions.HiLAException

Returns:

Throws:

eu.unicore.hila.exceptions.HiLAException