org.xwiki.job.event.status

Interface JobProgressStep

public interface JobProgressStep

Represents one step in the progress tree.

Since:

7.1M2

Version:

$Id: 0363c176be0aa474ac52c3b0e96864d15b8ea9c9 $

Method Summary

Modifier and Type	Method and Description
<S extends JobProgressStep> List<S>	getChildren()
long	getElapsedTime()
org.xwiki.logging.Message	getMessage()
double	getOffset()
JobProgressStep	getParent()

Method Detail

getMessage

org.xwiki.logging.Message getMessage()

Returns:

the message associated to the step, can be null

getParent

JobProgressStep getParent()

Returns:

the parent step

getChildren

<S extends JobProgressStep> List<S> getChildren()

Type Parameters:

S - the type of the step

Returns:

the children steps

getOffset

double getOffset()

Returns:

progress of the current step between 0 and 1

getElapsedTime

long getElapsedTime()

Returns:

the time spend executing the step, in nanoseconds