Package com.intellij.lang.annotation

Interface Annotator

All Known Implementing Classes:

DefaultDomAnnotator, FormClassAnnotator, GroovyDslAnnotator, HyperlinkAnnotator, JavaDocAnnotator, JavaFxAnnotator, JqlAnnotator, JsonLiteralAnnotator, LargeFilesAnnotator, MarkdownHighlightingAnnotator, ModelAnnotator, PropertiesAnnotator, PyAnnotatingVisitor, PyCharmProfessionalAdvertiser, PyCompatibilityInspectionAdvertiser, PyCompositeAnnotator, ReferenceAnnotator, RegExpAnnotator, RestAnnotatingVisitor, ShAnnotator, SPIAnnotator, ValueRegExpAnnotator, XmlNamespaceAnnotator, XmlNsPrefixAnnotator, XmlWrongClosingTagNameInspection, XPathAnnotator, XsltAnnotator, XsltXmlAnnotator, YAMLSameLineCompositeValueErrorAnnotator

public interface Annotator

Implemented by a custom language plugin to add annotations to files in the language.

DO NOT STORE any state inside annotator. If you absolutely must, clear the state upon exit from the annotate(PsiElement, AnnotationHolder) method.

See Syntax Highlighting and Error Highlighting for an overview.

See Also:

LanguageAnnotators

Method Summary

Modifier and Type	Method and Description
void	annotate(PsiElement element, AnnotationHolder holder) Annotates the specified PSI element.

Method Detail

annotate

void annotate(PsiElement element,
              AnnotationHolder holder)

Annotates the specified PSI element. It is guaranteed to be executed in non-reentrant fashion. I.e there will be no call of this method for this instance before previous call get completed. Multiple instances of the annotator might exist simultaneously, though.

Parameters:

element - to annotate.

holder - the container which receives annotations created by the plugin.