com.atlassian.jira.task

Class JohnsonEventProgressSink

java.lang.Object

com.atlassian.jira.task.JohnsonEventProgressSink

All Implemented Interfaces:

TaskProgressSink

public class JohnsonEventProgressSink
extends Object
implements TaskProgressSink

A task progress sink that can update a Johnson Event with progress updates.

Since:

v4.4

Field Summary

Fields inherited from interface com.atlassian.jira.task.TaskProgressSink

NULL_SINK

Constructor Summary

Constructors

Constructor and Description
JohnsonEventProgressSink(com.atlassian.johnson.event.Event event)

Method Summary

Modifier and Type	Method and Description
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 java.lang.Object

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

Constructor Detail

JohnsonEventProgressSink

public JohnsonEventProgressSink(com.atlassian.johnson.event.Event event)

Method Detail

makeProgress

public void makeProgress(long taskProgress,
                         String currentSubTask,
                         String message)

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 isn't one

message - an optional message about the progress; otherwise null