com.atlassian.jira.task

Interface TaskProgressSink

All Known Implementing Classes:

CompositeProgressSink, JohnsonEventProgressSink, LoggingProgressSink, ScalingTaskProgessSink, StatefulTaskProgressSink, StepTaskProgressSink, TimeBasedLogSink

public interface TaskProgressSink

Interface that can be used by tasks to indicate progress.

Since:

v3.13

Field Summary

Fields

Modifier and Type	Field and Description
static TaskProgressSink	NULL_SINK A simple sink that does nothing.

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.

Field Detail

NULL_SINK

static final TaskProgressSink NULL_SINK

A simple sink that does nothing.

Method Detail

makeProgress

void makeProgress(long taskProgress,
                  @Nullable
                  String currentSubTask,
                  @Nullable
                  String message)

This method can be called to indicate that progress is being made by a task.

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