Package com.intellij.lang.annotation

Class ExternalAnnotator<InitialInfoType,AnnotationResultType>

java.lang.Object

com.intellij.lang.annotation.ExternalAnnotator<InitialInfoType,AnnotationResultType>

Direct Known Subclasses:

Pep8ExternalAnnotator, RngSchemaValidator, ShShellcheckExternalAnnotator, WebReferencesAnnotatorBase, XMLExternalAnnotator, YouTrackHighlightingAnnotator

public abstract class ExternalAnnotator<InitialInfoType,AnnotationResultType>
extends java.lang.Object

Implemented by a custom language plugin to process the files in a language by an external annotation tool ("linter"). External annotators are expected to be (relatively) slow and are started after regular annotators have completed their work.

Annotators work in three steps:

1. collectInformation(PsiFile, Editor, boolean) is called to collect some data about a file needed for launching a tool
2. collected data is passed to doAnnotate(InitialInfoType) which executes a tool and collect highlighting data
3. highlighting data is applied to a file by apply(com.intellij.psi.PsiFile, AnnotationResultType, com.intellij.lang.annotation.AnnotationHolder)

See Also:

ExternalLanguageAnnotators

Constructor Summary

Constructors

Constructor and Description
ExternalAnnotator()

Method Summary

Modifier and Type	Method and Description
void	apply(PsiFile file, AnnotationResultType annotationResult, AnnotationHolder holder) Applies collected annotations to the given annotation holder.
InitialInfoType	collectInformation(PsiFile file)
InitialInfoType	collectInformation(PsiFile file, Editor editor, boolean hasErrors) Collects initial information needed for launching a tool.
AnnotationResultType	doAnnotate(InitialInfoType collectedInfo) Collects full information required for annotation.
java.lang.String	getPairedBatchInspectionShortName() Returns an inspection that should run in batch mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalAnnotator

public ExternalAnnotator()

Method Detail

collectInformation

public InitialInfoType collectInformation(PsiFile file)

See Also:

collectInformation(PsiFile, Editor, boolean)

collectInformation

public InitialInfoType collectInformation(PsiFile file,
                                          Editor editor,
                                          boolean hasErrors)

Collects initial information needed for launching a tool. This method is called within a read action; non-DumbAware annotators are skipped during indexing.

Parameters:

file - a file to annotate

editor - an editor in which file's document reside

hasErrors - indicates if file has errors detected by preceding analyses

Returns:

information to pass to ExternalAnnotator#doAnnotate(InitialInfoType), or null if not applicable

doAnnotate

public AnnotationResultType doAnnotate(InitialInfoType collectedInfo)

Collects full information required for annotation. This method is intended for long-running activities and will be called outside a read action; implementations should either avoid accessing indices and PSI or perform needed checks and locks themselves.

Parameters:

collectedInfo - initial information gathered by collectInformation(com.intellij.psi.PsiFile)

Returns:

annotations to pass to ExternalAnnotator#apply(PsiFile, AnnotationResultType, AnnotationHolder)

apply

public void apply(PsiFile file,
                  AnnotationResultType annotationResult,
                  AnnotationHolder holder)

Applies collected annotations to the given annotation holder. This method is called within a read action.

Parameters:

file - a file to annotate

annotationResult - annotations collected in ExternalAnnotator#doAnnotate(InitialInfoType)

holder - a container for receiving annotations

getPairedBatchInspectionShortName

public java.lang.String getPairedBatchInspectionShortName()

Returns an inspection that should run in batch mode.

When inspection with short name is disabled, then annotator won't run in the editor via ExternalToolPass. Implementing ExternalAnnotatorBatchInspection and extending LocalInspectionTool or GlobalSimpleInspectionTool would provide implementation for a batch tool that would run without read action, according to the doAnnotate(Object) documentation.