com.atlassian.jira.task.context

Class Contexts

java.lang.Object

com.atlassian.jira.task.context.Contexts

@PublicApi
public class Contexts
extends Object

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.

Since:

v4.0

Method Summary

Modifier and Type	Method and Description
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.
static Context	percentageLogger(Sized sized, org.apache.log4j.Logger logger, String msg) Deprecated. Use builder() instead. Since v6.4.
static Context	percentageLogger(Sized sized, org.apache.log4j.Logger logger, String msg, org.apache.log4j.Level level) Deprecated. Use builder() instead. Since v6.4.
static Context	percentageReporter(Sized sized, TaskProgressSink sink, I18nHelper i18n, org.apache.log4j.Logger logger, String msg) 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, org.apache.log4j.Logger logger, String msg, com.atlassian.johnson.event.Event event) 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+
static Context	percentageReporter(Sized sized, TaskProgressSink sink, I18nHelper i18n, org.apache.log4j.Logger logger, String msg, com.atlassian.johnson.event.Event event, org.apache.log4j.Level level) Deprecated. Since 6.3.6 use #percentageReporter(com.atlassian.jira.util.collect.Sized, TaskProgressSink, I18nHelper, Logger, String, String, String, com.atlassian.johnson.event.Event), Level in 6.3.6+ or builder() in 6.4+
static Context	percentageReporter(Sized sized, TaskProgressSink sink, I18nHelper i18n, org.apache.log4j.Logger logger, String msg, String uiMessageKeyPercentage, String uiMessageKeyCurrent) Deprecated. Use builder() instead. Since v6.4.
static Context	percentageReporter(Sized sized, TaskProgressSink sink, I18nHelper i18n, org.apache.log4j.Logger logger, String msg, String uiMessageKeyPercentage, String uiMessageKeyCurrent, com.atlassian.johnson.event.Event event)
static Context	percentageReporter(Sized sized, TaskProgressSink sink, I18nHelper i18n, org.apache.log4j.Logger logger, String msg, String uiMessageKeyPercentage, String uiMessageKeyCurrent, com.atlassian.johnson.event.Event event, org.apache.log4j.Level level) Deprecated. Use builder() instead. Since v6.4.
static Context	percentageReporter(Sized sized, TaskProgressSink sink, I18nHelper i18n, org.apache.log4j.Logger logger, String msg, String uiMessageKeyPercentage, String uiMessageKeyCurrent, org.apache.log4j.Level level) Deprecated. Use builder() instead. Since v6.4.

Methods inherited from class java.lang.Object

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

Method Detail

nullContext

public static Context nullContext()

A context which ignores all progress reported to it and has no side-effects.

percentageReporter

@Deprecated
public static Context percentageReporter(@Nonnull
                                                     Sized sized,
                                                     @Nonnull
                                                     TaskProgressSink sink,
                                                     @Nonnull
                                                     I18nHelper i18n,
                                                     @Nonnull
                                                     org.apache.log4j.Logger logger,
                                                     @Nonnull
                                                     String msg)

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+

percentageReporter

public static Context percentageReporter(@Nonnull
                                         Sized sized,
                                         @Nonnull
                                         TaskProgressSink sink,
                                         @Nonnull
                                         I18nHelper i18n,
                                         @Nonnull
                                         org.apache.log4j.Logger logger,
                                         @Nonnull
                                         String msg,
                                         @Nonnull
                                         String uiMessageKeyPercentage,
                                         String uiMessageKeyCurrent)

Deprecated. Use builder() instead. Since v6.4.

percentageReporter

public static Context percentageReporter(@Nonnull
                                         Sized sized,
                                         @Nonnull
                                         TaskProgressSink sink,
                                         @Nonnull
                                         I18nHelper i18n,
                                         @Nonnull
                                         org.apache.log4j.Logger logger,
                                         @Nonnull
                                         String msg,
                                         @Nonnull
                                         String uiMessageKeyPercentage,
                                         String uiMessageKeyCurrent,
                                         @Nonnull
                                         org.apache.log4j.Level level)

Deprecated. Use builder() instead. Since v6.4.

percentageReporter

@Deprecated
public static Context percentageReporter(@Nonnull
                                                     Sized sized,
                                                     @Nonnull
                                                     TaskProgressSink sink,
                                                     @Nonnull
                                                     I18nHelper i18n,
                                                     @Nonnull
                                                     org.apache.log4j.Logger logger,
                                                     @Nonnull
                                                     String msg,
                                                     @Nonnull
                                                     com.atlassian.johnson.event.Event event)

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+

percentageReporter

@Deprecated
public static Context percentageReporter(@Nonnull
                                                     Sized sized,
                                                     @Nonnull
                                                     TaskProgressSink sink,
                                                     @Nonnull
                                                     I18nHelper i18n,
                                                     @Nonnull
                                                     org.apache.log4j.Logger logger,
                                                     @Nonnull
                                                     String msg,
                                                     @Nonnull
                                                     com.atlassian.johnson.event.Event event,
                                                     org.apache.log4j.Level level)

Deprecated. Since 6.3.6 use #percentageReporter(com.atlassian.jira.util.collect.Sized, TaskProgressSink, I18nHelper, Logger, String, String, String, com.atlassian.johnson.event.Event), Level in 6.3.6+ or builder() in 6.4+

percentageReporter

public static Context percentageReporter(@Nonnull
                                         Sized sized,
                                         @Nonnull
                                         TaskProgressSink sink,
                                         @Nonnull
                                         I18nHelper i18n,
                                         @Nonnull
                                         org.apache.log4j.Logger logger,
                                         @Nonnull
                                         String msg,
                                         @Nonnull
                                         String uiMessageKeyPercentage,
                                         String uiMessageKeyCurrent,
                                         @Nonnull
                                         com.atlassian.johnson.event.Event event)

percentageReporter

@Deprecated
public static Context percentageReporter(@Nonnull
                                                     Sized sized,
                                                     @Nonnull
                                                     TaskProgressSink sink,
                                                     @Nonnull
                                                     I18nHelper i18n,
                                                     @Nonnull
                                                     org.apache.log4j.Logger logger,
                                                     @Nonnull
                                                     String msg,
                                                     @Nonnull
                                                     String uiMessageKeyPercentage,
                                                     String uiMessageKeyCurrent,
                                                     @Nonnull
                                                     com.atlassian.johnson.event.Event event,
                                                     org.apache.log4j.Level level)

Deprecated. Use builder() instead. Since v6.4.

percentageLogger

@Deprecated
public static Context percentageLogger(@Nonnull
                                                   Sized sized,
                                                   @Nonnull
                                                   org.apache.log4j.Logger logger,
                                                   @Nonnull
                                                   String msg)

Deprecated. Use builder() instead. Since v6.4.

percentageLogger

@Deprecated
public static Context percentageLogger(@Nonnull
                                                   Sized sized,
                                                   @Nonnull
                                                   org.apache.log4j.Logger logger,
                                                   @Nonnull
                                                   String msg,
                                                   org.apache.log4j.Level level)

Deprecated. Use builder() instead. Since v6.4.

builder

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.

Since:

v6.4