org.xwiki.job.script

Class ProgressScripService

java.lang.Object

org.xwiki.job.script.ProgressScripService

All Implemented Interfaces:

ScriptService

@Component
 @Singleton
 @Named(value="progress")
public class ProgressScripService
extends Object
implements ScriptService

Some script oriented helpers to impact current progress.

Since:

7.1M2

Version:

$Id: 2e8f8e81c4effe32ef4587c678fe5d03e3249712 $

Constructor Summary

Constructors

Constructor and Description
ProgressScripService()

Method Summary

Modifier and Type	Method and Description
void	endStep() Close current step.
void	popLevel() Pop current progression level.
void	pushLevel() Push new progression level with unknown number of steps.
void	pushLevel(int steps) Push new progression level.
void	startStep() Close current step if any and move to next one.
void	startStep(String name) Close current step if any and move to next one.
void	startStep(String translationKey, String message, Object... arguments) Close current step if any and move to next one.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProgressScripService

public ProgressScripService()

Method Detail

pushLevel

public void pushLevel()

Push new progression level with unknown number of steps.

pushLevel

public void pushLevel(int steps)

Push new progression level.

Parameters:

steps - number of steps in this new level

popLevel

public void popLevel()

Pop current progression level.

startStep

public void startStep()

Close current step if any and move to next one.

startStep

public void startStep(String name)

Close current step if any and move to next one.

Parameters:

name - the name of the step

startStep

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

Close current step if any and move to next one.

Parameters:

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

endStep

public void endStep()

Close current step.