replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-impl / src / com / intellij / openapi / application / PreloadingActivity.java
1 /*
2  * Copyright 2000-2015 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.openapi.application;
17
18 import com.intellij.openapi.extensions.ExtensionPointName;
19 import com.intellij.openapi.progress.ProgressIndicator;
20 import org.jetbrains.annotations.NotNull;
21
22 /**
23  * An activity to be executed in background on IDE startup. It may load some classes or other configuration
24  * so that when something (e.g. an action) is invoked the first time in the UI, there's no visible pause
25  * while required stuff is being lazily loaded.
26  *
27  * @author peter
28  * @since 144
29  */
30 public abstract class PreloadingActivity {
31   public static final ExtensionPointName<PreloadingActivity> EP_NAME = ExtensionPointName.create("com.intellij.preloadingActivity");
32
33   /**
34    * Perform the preloading
35    * @param indicator a progress indicator for the background preloading process.
36    *                  Canceled if the application has exited.
37    *                  Long actions should periodically perform {@code indicator.checkCanceled()}.
38    */
39   public abstract void preload(@NotNull ProgressIndicator indicator);
40
41 }