com.intellij.lang.annotation
Interface AnnotationHolder

public interface AnnotationHolder

Allows a custom language plugin to define annotations for files in that language.

See Also:

Annotator.annotate(com.intellij.psi.PsiElement, AnnotationHolder)

Method Summary

Annotation	createErrorAnnotation(ASTNode node, java.lang.String message) Creates an error annotation with the specified message over the specified AST node.
Annotation	createErrorAnnotation(PsiElement elt, java.lang.String message) Creates an error annotation with the specified message over the specified PSI element.
Annotation	createErrorAnnotation(TextRange range, java.lang.String message) Creates an error annotation with the specified message over the specified text range.
Annotation	createInfoAnnotation(ASTNode node, java.lang.String message) Creates an information annotation with the specified message over the specified AST node.
Annotation	createInfoAnnotation(PsiElement elt, java.lang.String message) Creates an information annotation with the specified message over the specified PSI element.
Annotation	createInfoAnnotation(TextRange range, java.lang.String message) Creates an information annotation with the specified message over the specified text range.
Annotation	createWarningAnnotation(ASTNode node, java.lang.String message) Creates a warning annotation with the specified message over the specified AST node.
Annotation	createWarningAnnotation(PsiElement elt, java.lang.String message) Creates a warning annotation with the specified message over the specified PSI element.
Annotation	createWarningAnnotation(TextRange range, java.lang.String message) Creates a warning annotation with the specified message over the specified text range.

Method Detail

createErrorAnnotation

Annotation createErrorAnnotation(PsiElement elt,
                                 @Nullable
                                 java.lang.String message)

Creates an error annotation with the specified message over the specified PSI element.

Parameters:

elt - the element over which the annotation is created.

message - the error message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createErrorAnnotation

Annotation createErrorAnnotation(ASTNode node,
                                 @Nullable
                                 java.lang.String message)

Creates an error annotation with the specified message over the specified AST node.

Parameters:

node - the node over which the annotation is created.

message - the error message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createErrorAnnotation

Annotation createErrorAnnotation(TextRange range,
                                 @Nullable
                                 java.lang.String message)

Creates an error annotation with the specified message over the specified text range.

Parameters:

range - the text range over which the annotation is created.

message - the error message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createWarningAnnotation

Annotation createWarningAnnotation(PsiElement elt,
                                   @Nullable
                                   java.lang.String message)

Creates a warning annotation with the specified message over the specified PSI element.

Parameters:

elt - the element over which the annotation is created.

message - the warning message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createWarningAnnotation

Annotation createWarningAnnotation(ASTNode node,
                                   @Nullable
                                   java.lang.String message)

Creates a warning annotation with the specified message over the specified AST node.

Parameters:

node - the node over which the annotation is created.

message - the warning message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createWarningAnnotation

Annotation createWarningAnnotation(TextRange range,
                                   @Nullable
                                   java.lang.String message)

Creates a warning annotation with the specified message over the specified text range.

Parameters:

range - the text range over which the annotation is created.

message - the warning message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createInfoAnnotation

Annotation createInfoAnnotation(PsiElement elt,
                                @Nullable
                                java.lang.String message)

Creates an information annotation with the specified message over the specified PSI element.

Parameters:

elt - the element over which the annotation is created.

message - the information message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createInfoAnnotation

Annotation createInfoAnnotation(ASTNode node,
                                @Nullable
                                java.lang.String message)

Creates an information annotation with the specified message over the specified AST node.

Parameters:

node - the node over which the annotation is created.

message - the information message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createInfoAnnotation

Annotation createInfoAnnotation(TextRange range,
                                java.lang.String message)

Creates an information annotation with the specified message over the specified text range.

Parameters:

range - the text range over which the annotation is created.

message - the information message.

Returns:

the annotation (which can be modified to set additional annotation parameters)