Class Overview
This TaskProgressSink will output progress to the Logger if either the percentage progress changes or its been more than
n milliseconds since the last log entry.
Summary
Public Methods |
void
|
makeProgress(long taskProgress, String currentSubTask, String message)
This method can be called to indicate that progress is being made by a
task.
|
[Expand]
Inherited Methods |
From class
com.atlassian.jira.task.StatefulTaskProgressSink
static
Collection<StatefulTaskProgressSink>
|
createPercentageSinksForRange(long startRange, long endRange, int numberOfDivisions, TaskProgressSink sink)
Return a collection of sinks that allows progress to be reported across the specified ragnge.
|
StepTaskProgressSink
|
createStepSinkView(long startProgress, long length, int numberOfActions)
|
StepTaskProgressSink
|
createStepSinkView(long length, int numberOfActions)
|
long
|
getMaxProgress()
|
long
|
getMinProgress()
|
long
|
getProgress()
|
void
|
makeProgress(String currentSubTask, String message)
Send a new progress message without changing the current task progress.
|
void
|
makeProgress(long taskProgress, String currentSubTask, String message)
This method can be called to indicate that progress is being made by a
task.
|
void
|
makeProgressIncrement(long increment, String currentSubTask, String message)
This method can be called to indicate that progress is being made by a
task.
|
void
|
setProgress(long currentProgress)
Set the progress stored in the sink.
|
|
From class
java.lang.Object
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
|
From interface
com.atlassian.jira.task.TaskProgressSink
void
|
makeProgress(long taskProgress, String currentSubTask, String message)
This method can be called to indicate that progress is being made by a task.
|
|
Public Constructors
public
TimeBasedLogSink
(Logger log, String description, long maxTimeBetweenEvents, TaskProgressSink delegateSink)
Public Methods
public
void
makeProgress
(long taskProgress, String currentSubTask, String message)
This method can be called to indicate that progress is being made by a
task.
Parameters
taskProgress
| the current status of the task. This value will be clamped
between the minimum and maximum progress specified when the object is constructed. |
currentSubTask
| the name of the current sub task or null if there isn't one |
message
| an optional message about the progress or null
|