cleanup
[idea/community.git] / platform / util / concurrency / com / intellij / util / concurrency / NonUrgentExecutor.java
1 // Copyright 2000-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
2 package com.intellij.util.concurrency;
3
4 import org.jetbrains.annotations.NotNull;
5
6 import java.util.concurrent.Executor;
7
8 /**
9  * A common executor for non-urgent tasks, which are expected to be fast (preferably not more than 10 seconds) most of the time.
10  * Used to avoid spawning a lot of threads by different subsystems all reacting to the same event,
11  * when all they have to do is several short PSI/index queries in reaction to a file or project model change,
12  * or on project opening. If you're using {@link com.intellij.openapi.application.ReadAction#nonBlocking},
13  * you might consider this executor as backend. This executor is bounded, so please don't perform long-running
14  * or potentially blocking operations here.
15  * <p></p>
16  *
17  * Not to be used:
18  * <ul>
19  *   <li>For activities that can take significant time, e.g. project-wide Find Usages, or a Web query or slow I/O</li>
20  *   <li>For background processes started by user actions, where people would wait for results, staring at the screen impatiently.</li>
21  * </ul>
22  */
23 public final class NonUrgentExecutor implements Executor {
24   private static final NonUrgentExecutor ourInstance = new NonUrgentExecutor();
25   private final Executor myBackend = AppExecutorUtil.createBoundedApplicationPoolExecutor("NonUrgentExecutor", 2, false);
26
27   private NonUrgentExecutor() {
28   }
29
30   @Override
31   public void execute(@NotNull Runnable command) {
32     myBackend.execute(command);
33   }
34
35   public static @NotNull NonUrgentExecutor getInstance() {
36     return ourInstance;
37   }
38 }