44b3e1b23d3905c935dbe0b2b366ebbfc1dd89aa
[idea/community.git] / platform / editor-ui-api / src / com / intellij / codeHighlighting / HighlightingPass.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.codeHighlighting;
17
18 import com.intellij.openapi.progress.ProgressIndicator;
19 import org.jetbrains.annotations.NotNull;
20
21 /**
22  * Pass performs analysis in background and highlights found issues in the editor.
23  */
24 public interface HighlightingPass {
25   HighlightingPass[] EMPTY_ARRAY = new HighlightingPass[0];
26
27   /**
28    * Asks this pass to start analysis and hold collected information.
29    * This method is called from a background thread.
30    *
31    * @param progress to check if highlighting process is cancelled. Pass is to check progress.isCanceled() as often as possible and
32    *                 throw {@link com.intellij.openapi.progress.ProcessCanceledException} if <code>true</code> is returned.
33    *                 See also {@link com.intellij.openapi.progress.ProgressIndicator#checkCanceled()}.
34    */
35   void collectInformation(@NotNull ProgressIndicator progress);
36
37   /**
38    * Called to apply information collected by {@linkplain #collectInformation(com.intellij.openapi.progress.ProgressIndicator)} to the editor.
39    * This method is called from the event dispatch thread.
40    */
41   void applyInformationToEditor();
42 }