|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface Progress
Progress statistics for a process. This is represented by an amount completed, a total amount (if
known), and a unit. There are some predefined unit types (BYTES, ENTITIES),
but any unit can be used.
| Field Summary | |
|---|---|
static String |
BYTES
The predefined unit type "bytes". |
static String |
ENTITIES
The predefined unit type "entities". |
| Method Summary | |
|---|---|
long |
getCompleted()
The amount completed, in terms of units specified by getUnit(). |
long |
getTotal()
The total amount being processed, in terms of units specified by getUnit(). |
String |
getUnit()
The unit type represented by the getCompleted() and getTotal() numbers. |
boolean |
isApproximate()
Returns true if the progress staistics are approximate, for example if the total number of entities in the collection is not known. |
| Field Detail |
|---|
static final String ENTITIES
static final String BYTES
| Method Detail |
|---|
long getCompleted()
getUnit().
long getTotal()
getUnit(). For some
processes, this information may not be available - in these cases, -1 will be returned.
String getUnit()
getCompleted() and getTotal() numbers. There
are some predefined unit types (BYTES, ENTITIES), but any unit can be
used.
boolean isApproximate()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||