Contexts

extends Object

java.lang.Object
↳	com.atlassian.jira.task.context.Contexts

@PublicApi

This class is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Provides static methods for creating Context instances easily.

Contexts provide background tasks with information about the work to be performed, including how the task can report on the task's progress.

Summary

Public Methods
static Context.Builder	builder() Returns a new `Context.Builder` for constructing a background task `Context`.
static Context	nullContext() A context which ignores all progress reported to it and has no side-effects.
@Deprecated static Context	percentageLogger(Sized sized, Logger logger, String msg, Level level) This method is deprecated. Use `builder()` instead. Since v6.4.
@Deprecated static Context	percentageLogger(Sized sized, Logger logger, String msg) This method is deprecated. Use `builder()` instead. Since v6.4.
@Deprecated static Context	percentageReporter(Sized sized, TaskProgressSink sink, I18nHelper i18n, Logger logger, String msg) This method is deprecated. Since 6.3.6 use `percentageReporter(com.atlassian.jira.util.collect.Sized, TaskProgressSink, I18nHelper, Logger, String, String, String)` for 6.3.6+ or `builder()` for 6.4+
static Context	percentageReporter(Sized sized, TaskProgressSink sink, I18nHelper i18n, Logger logger, String msg, String uiMessageKeyPercentage, String uiMessageKeyCurrent) This method is deprecated. Use `builder()` instead. Since v6.4.
static Context	percentageReporter(Sized sized, TaskProgressSink sink, I18nHelper i18n, Logger logger, String msg, String uiMessageKeyPercentage, String uiMessageKeyCurrent, Event event)
@Deprecated static Context	percentageReporter(Sized sized, TaskProgressSink sink, I18nHelper i18n, Logger logger, String msg, String uiMessageKeyPercentage, String uiMessageKeyCurrent, Event event, Level level) This method is deprecated. Use `builder()` instead. Since v6.4.
static Context	percentageReporter(Sized sized, TaskProgressSink sink, I18nHelper i18n, Logger logger, String msg, String uiMessageKeyPercentage, String uiMessageKeyCurrent, Level level) This method is deprecated. Use `builder()` instead. Since v6.4.
@Deprecated static Context	percentageReporter(Sized sized, TaskProgressSink sink, I18nHelper i18n, Logger logger, String msg, Event event, Level level) This method is deprecated. Since 6.3.6 use `Level` in 6.3.6+ or `builder()` in 6.4+
@Deprecated static Context	percentageReporter(Sized sized, TaskProgressSink sink, I18nHelper i18n, Logger logger, String msg, Event event) This method is deprecated. Since 6.3.6 use `percentageReporter(com.atlassian.jira.util.collect.Sized, TaskProgressSink, I18nHelper, Logger, String, String, String, com.atlassian.johnson.event.Event)` in 6.3.6+ or `builder()` in 6.4+

[Expand]

Inherited Methods

From class java.lang.Object

Public Methods

public static Context.Builder builder ()

Returns a new Context.Builder for constructing a background task Context.

Returns

a new Context.Builder for constructing a background task Context.