lvcs-impl
[idea/community.git] / platform / lang-api / src / com / intellij / lang / annotation / ExternalAnnotator.java
1 /*
2  * Copyright 2000-2007 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.lang.annotation;
17
18 import com.intellij.psi.PsiFile;
19
20 import java.util.Collections;
21 import java.util.List;
22
23 /**
24  * Implemented by a custom language plugin to process the files in a language by an
25  * external annotation tool. The external annotator is expected to be slow and is started
26  * after the regular annotator has completed its work.
27  *
28  * @author ven
29  */
30 public interface ExternalAnnotator {
31   List<ExternalAnnotator> EMPTY_LIST = Collections.unmodifiableList(Collections.<ExternalAnnotator>emptyList());
32
33   /**
34    * Annotates the specified file.
35    *
36    * @param file   the file to annotate.
37    * @param holder the container which receives annotations created by the plugin.
38    */
39   void annotate(PsiFile file, AnnotationHolder holder);
40 }