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

public static class Work.Progress
extends Object
implements Serializable

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:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	CURRENT_INDETERMINATE
static float	PERCENT_INDETERMINATE
static Work.Progress	PROGRESS_0_PC
static Work.Progress	PROGRESS_100_PC
static Work.Progress	PROGRESS_INDETERMINATE

Constructor Summary

Constructors

Constructor and Description
Work.Progress(float percent) Constructs a Work.Progress as a percentage.
Work.Progress(long current, long total) Constructs a Work.Progress as a current and total count.

Method Summary

Methods

Modifier and Type	Method and Description
long	getCurrent()
boolean	getIsIndeterminate()
boolean	getIsWithCurrentAndTotal()
boolean	getIsWithPercent()
float	getPercent()
long	getTotal()
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CURRENT_INDETERMINATE

public static long CURRENT_INDETERMINATE

PERCENT_INDETERMINATE

public static float PERCENT_INDETERMINATE

PROGRESS_INDETERMINATE

public static final Work.Progress PROGRESS_INDETERMINATE

PROGRESS_0_PC

public static final Work.Progress PROGRESS_0_PC

PROGRESS_100_PC

public static final Work.Progress PROGRESS_100_PC

Constructor Detail

Work.Progress

public Work.Progress(float percent)

Constructs a Work.Progress as a percentage.

Parameters:

percent - the percentage, a float between 0 and 100, or PERCENT_INDETERMINATE

Work.Progress

public Work.Progress(long current,
             long total)

Constructs a Work.Progress as a current and total count.

Parameters:

current - the current count or CURRENT_INDETERMINATE

total - the total count

Method Detail

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

public String toString()

Overrides:

toString in class Object