org.xwiki.job.event.status

Interface JobProgressManager

@Role
public interface JobProgressManager

Helper to manipulate current progress.

Since:

6.1M1

Version:

$Id: 7c78f6c4d5b7487a2061deab9834f0bb50cb5265 $

Method Summary

Modifier and Type	Method and Description
<T> T	call(Callable<T> task, int steps, Object source) Automatically push and pop progression level around passed task.
<T> T	call(Callable<T> task, Object source) Automatically push and pop progression level with unknown number of steps around passed task.
void	endStep(Object source) Close the current step.
void	popLevelProgress(Object source) Pop current progression level.
void	pushLevelProgress(int steps, Object source) Push new progression level.
void	pushLevelProgress(Object source) Push new progression level with unknown number of steps.
void	startStep(Object source) Close the current step if any and start a new one with provided name.
void	startStep(Object source, org.xwiki.logging.Message message) Close the current step if any and start a new one with provided name.
void	startStep(Object source, String name) Close the current step if any and start a new one with provided name.
void	startStep(Object source, String translationKey, String message, Object... arguments) Close the current step if any and start a new one with provided name.
void	stepPropress(Object source) Deprecated. since 7.1M2, use startStep(Object) instead

Method Detail

pushLevelProgress

void pushLevelProgress(Object source)

Push new progression level with unknown number of steps.

Parameters:

source - the source to send with the event

pushLevelProgress

void pushLevelProgress(int steps,
                       Object source)

Push new progression level.

Parameters:

steps - number of steps in this new level

source - the source to send with the event

stepPropress

@Deprecated
void stepPropress(Object source)

Deprecated. since 7.1M2, use startStep(Object) instead

Close the current step and start a new one.

Parameters:

source - the source to send with the event

startStep

void startStep(Object source)

Close the current step if any and start a new one with provided name.

Parameters:

source - the source to send with the event

Since:

7.1M2

startStep

void startStep(Object source,
               String name)

Close the current step if any and start a new one with provided name.

Parameters:

source - the source to send with the event

name - the name associated to the next step

Since:

7.1M2

startStep

void startStep(Object source,
               String translationKey,
               String message,
               Object... arguments)

Close the current step if any and start a new one with provided name.

Parameters:

source - the source to send with the event

translationKey - the key used to find the translation of the step message

message - the default message associated to the step

arguments - the arguments to insert in the step message

Since:

7.1M2

startStep

void startStep(Object source,
               org.xwiki.logging.Message message)

Close the current step if any and start a new one with provided name.

Parameters:

source - the source to send with the event

message - the message associated to the next step

Since:

7.1M2

endStep

void endStep(Object source)

Close the current step.

Parameters:

source - the source to send with the event

Since:

7.1M2

popLevelProgress

void popLevelProgress(Object source)

Pop current progression level.

Parameters:

source - the source to send with the event

call

<T> T call(Callable<T> task,
           Object source)
    throws Exception

Automatically push and pop progression level with unknown number of steps around passed task.

Type Parameters:

T - the return type

Parameters:

task - the task to execute

source - the source to send with the event

Returns:

computed result

Throws:

Exception - if unable to compute a result

Since:

7.1M1

call

<T> T call(Callable<T> task,
           int steps,
           Object source)
    throws Exception

Automatically push and pop progression level around passed task.

Type Parameters:

T - the return type

Parameters:

task - the task to execute

steps - number of steps in this new level

source - the source to send with the event

Returns:

computed result

Throws:

Exception - if unable to compute a result

Since:

7.1M1