Package com.intellij.util.concurrency

Class Invoker.Background

java.lang.Object

com.intellij.util.concurrency.Invoker

com.intellij.util.concurrency.Invoker.Background

All Implemented Interfaces:

Disposable

Enclosing class:

Invoker

public static final class Invoker.Background
extends Invoker

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.util.concurrency.Invoker

Invoker.Background, Invoker.BackgroundThread, Invoker.EDT

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Constructor Summary

Constructors

Constructor and Description
Background(Disposable parent) Deprecated. use Invoker.forBackgroundThreadWithReadAction(com.intellij.openapi.Disposable) instead
Background(Disposable parent, boolean useReadAction) Deprecated. use Invoker.forBackgroundThreadWithReadAction(com.intellij.openapi.Disposable) or Invoker.forBackgroundThreadWithoutReadAction(com.intellij.openapi.Disposable) instead
Background(Disposable parent, int maxThreads) Deprecated. use Invoker.forBackgroundPoolWithReadAction(com.intellij.openapi.Disposable) instead
Background(Disposable parent, ThreeState useReadAction) Deprecated. use Invoker.forBackgroundThreadWithReadAction(com.intellij.openapi.Disposable) or Invoker.forBackgroundThreadWithoutReadAction(com.intellij.openapi.Disposable) instead
Background(Disposable parent, ThreeState useReadAction, int maxThreads) Deprecated. use Invoker.forBackgroundThreadWithReadAction(com.intellij.openapi.Disposable) or Invoker.forBackgroundThreadWithoutReadAction(com.intellij.openapi.Disposable) instead

Method Summary

Modifier and Type	Method and Description
void	dispose() Usually not invoked directly, see class javadoc.
boolean	isValidThread() Returns true if the current thread allows to process a task.

Methods inherited from class com.intellij.util.concurrency.Invoker

compute, computeLater, computeLater, forBackgroundPoolWithReadAction, forBackgroundThreadWithoutReadAction, forBackgroundThreadWithReadAction, forEventDispatchThread, getTaskCount, invoke, invokeLater, invokeLater, runOrInvokeLater, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Background

@Deprecated
public Background(Disposable parent)

Deprecated. use Invoker.forBackgroundThreadWithReadAction(com.intellij.openapi.Disposable) instead

Creates the invoker of user read actions on a background thread.

Parameters:

parent - a disposable parent object

Background

@Deprecated
public Background(Disposable parent,
                  int maxThreads)

Deprecated. use Invoker.forBackgroundPoolWithReadAction(com.intellij.openapi.Disposable) instead

Creates the invoker of user read actions on background threads.

Parameters:

parent - a disposable parent object

maxThreads - the number of threads used for parallel calculation, where 1 guarantees sequential calculation, which allows not to use additional synchronization

Background

@Deprecated
public Background(Disposable parent,
                  boolean useReadAction)

Deprecated. use Invoker.forBackgroundThreadWithReadAction(com.intellij.openapi.Disposable) or Invoker.forBackgroundThreadWithoutReadAction(com.intellij.openapi.Disposable) instead

Creates the invoker of user tasks on a background thread.

Parameters:

parent - a disposable parent object

useReadAction - true to run user tasks as read actions with write action priority, false to run user tasks without read locks

Background

@Deprecated
public Background(Disposable parent,
                  ThreeState useReadAction)

Deprecated. use Invoker.forBackgroundThreadWithReadAction(com.intellij.openapi.Disposable) or Invoker.forBackgroundThreadWithoutReadAction(com.intellij.openapi.Disposable) instead

Creates the invoker of user tasks on a background thread.

Parameters:

parent - a disposable parent object

useReadAction - YES to run user tasks as read actions with write action priority, NO to run user tasks without read locks, UNSURE does not guarantee that read action is allowed

Background

@Deprecated
public Background(Disposable parent,
                  ThreeState useReadAction,
                  int maxThreads)

Deprecated. use Invoker.forBackgroundThreadWithReadAction(com.intellij.openapi.Disposable) or Invoker.forBackgroundThreadWithoutReadAction(com.intellij.openapi.Disposable) instead

Creates the invoker of user tasks on background threads.

Parameters:

parent - a disposable parent object

useReadAction - YES to run user tasks as read actions with write action priority, NO to run user tasks without read locks, UNSURE does not guarantee that read action is allowed

maxThreads - the number of threads used for parallel calculation, where 1 guarantees sequential calculation, which allows not to use additional synchronization

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

Overrides:

dispose in class Invoker

isValidThread

public boolean isValidThread()

Description copied from class: Invoker

Returns true if the current thread allows to process a task.

Overrides:

isValidThread in class Invoker

Returns:

true if the current thread is valid, or false otherwise