Package org.nuxeo.ecm.core.work.api
Class Work.Progress
java.lang.Object
org.nuxeo.ecm.core.work.api.Work.Progress
- All Implemented Interfaces:
Serializable
- Enclosing interface:
- Work
A progress report about a work instance.
Progress can be expressed as a percentage, or with a current and total count.
- 26.2% (percent not indeterminate)
- 12/345 (current not indeterminate)
- ?/345 (percent and current indeterminate but total non-zero)
- ? (percent and current indeterminate and total zero)
- Since:
- 5.6
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected final long
static final long
protected final float
static final float
static final Work.Progress
static final Work.Progress
static final Work.Progress
protected final long
-
Constructor Summary
ConstructorDescriptionProgress
(float percent) Constructs aWork.Progress
as a percentage.Progress
(long current, long total) Constructs aWork.Progress
as a current and total count. -
Method Summary
-
Field Details
-
CURRENT_INDETERMINATE
public static final long CURRENT_INDETERMINATE- See Also:
-
PERCENT_INDETERMINATE
public static final float PERCENT_INDETERMINATE- See Also:
-
PROGRESS_INDETERMINATE
-
PROGRESS_0_PC
-
PROGRESS_100_PC
-
percent
protected final float percent -
current
protected final long current -
total
protected final long total
-
-
Constructor Details
-
Progress
public Progress(float percent) Constructs aWork.Progress
as a percentage.- Parameters:
percent
- the percentage, a float between 0 and 100, orPERCENT_INDETERMINATE
-
Progress
public Progress(long current, long total) Constructs aWork.Progress
as a current and total count.- Parameters:
current
- the current count orCURRENT_INDETERMINATE
total
- the total count
-
-
Method Details
-
getPercent
public float getPercent() -
getCurrent
public long getCurrent() -
getTotal
public long getTotal() -
getIsWithPercent
public boolean getIsWithPercent() -
getIsWithCurrentAndTotal
public boolean getIsWithCurrentAndTotal() -
getIsIndeterminate
public boolean getIsIndeterminate() -
toString
-