com.atlassian.jira.task
Class TimeBasedLogSink

java.lang.Object
  extended by com.atlassian.jira.task.StatefulTaskProgressSink
      extended by com.atlassian.jira.task.TimeBasedLogSink
All Implemented Interfaces:
TaskProgressSink

public class TimeBasedLogSink
extends StatefulTaskProgressSink

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.

Since:
v3.13

Field Summary
 
Fields inherited from interface com.atlassian.jira.task.TaskProgressSink
NULL_SINK
 
Constructor Summary
TimeBasedLogSink(org.apache.log4j.Logger log, String description, long maxTimeBetweenEvents, TaskProgressSink delegateSink)
           
 
Method Summary
 void makeProgress(long taskProgress, String currentSubTask, String message)
          This method can be called to indicate that progress is being made by a task.
 
Methods inherited from class com.atlassian.jira.task.StatefulTaskProgressSink
createPercentageSinksForRange, createStepSinkView, createStepSinkView, getMaxProgress, getMinProgress, getProgress, makeProgress, makeProgressIncrement, setProgress
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TimeBasedLogSink

public TimeBasedLogSink(org.apache.log4j.Logger log,
                        String description,
                        long maxTimeBetweenEvents,
                        TaskProgressSink delegateSink)
Method Detail

makeProgress

public void makeProgress(long taskProgress,
                         String currentSubTask,
                         String message)
Description copied from class: StatefulTaskProgressSink
This method can be called to indicate that progress is being made by a task.

Specified by:
makeProgress in interface TaskProgressSink
Overrides:
makeProgress in class StatefulTaskProgressSink
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


Copyright © 2002-2013 Atlassian. All Rights Reserved.