com.atlassian.jira.task
Class LoggingProgressSink

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

public class LoggingProgressSink
extends Object
implements TaskProgressSink

A task progress sink that will log progress updates to the logger passed in.

Since:
v4.4

Field Summary
 
Fields inherited from interface com.atlassian.jira.task.TaskProgressSink
NULL_SINK
 
Constructor Summary
LoggingProgressSink(org.apache.log4j.Logger logger, String message, int increment)
           
 
Method Summary
 void makeProgress(long taskProgress, String currentSubTask, String msg)
          This method can be called to indicate that progress is being made by a task.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LoggingProgressSink

public LoggingProgressSink(org.apache.log4j.Logger logger,
                           String message,
                           int increment)
Method Detail

makeProgress

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

Specified by:
makeProgress in interface TaskProgressSink
Parameters:
taskProgress - an amount that indicates what progress has been made.
currentSubTask - the name of the current sub task or null if there isnt one
msg - an optional message about the progress or null


Copyright © 2002-2012 Atlassian. All Rights Reserved.