public class

TimeBasedLogSink

extends StatefulTaskProgressSink
java.lang.Object
   ↳ com.atlassian.jira.task.StatefulTaskProgressSink
     ↳ com.atlassian.jira.task.TimeBasedLogSink

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

[Expand]
Inherited Fields
From interface com.atlassian.jira.task.TaskProgressSink
Public Constructors
TimeBasedLogSink(Logger log, String description, long maxTimeBetweenEvents, TaskProgressSink delegateSink)
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
From class java.lang.Object
From interface com.atlassian.jira.task.TaskProgressSink

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