Package com.intellij.codeInsight.daemon.impl

Class AnnotationHolderImpl

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

com.intellij.util.SmartList<Annotation>

com.intellij.codeInsight.daemon.impl.AnnotationHolderImpl

All Implemented Interfaces:

AnnotationHolder, java.lang.Iterable<Annotation>, java.util.Collection<Annotation>, java.util.List<Annotation>, java.util.RandomAccess

public class AnnotationHolderImpl
extends SmartList<Annotation>
implements AnnotationHolder

Use AnnotationHolder instead. The members of this class can suddenly change or disappear.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
AnnotationHolderImpl(AnnotationSession session) Do not instantiate the AnnotationHolderImpl directly, please use the one provided to Annotator.annotate(PsiElement, AnnotationHolder) instead
AnnotationHolderImpl(AnnotationSession session, boolean batchMode) Do not instantiate the AnnotationHolderImpl directly, please use the one provided to Annotator.annotate(PsiElement, AnnotationHolder) instead

Method Summary

Modifier and Type	Method and Description
<R> void	applyExternalAnnotatorWithContext(PsiFile file, ExternalAnnotator<?,R> annotator, R result)
void	assertAllAnnotationsCreated()
Annotation	createAnnotation(HighlightSeverity severity, TextRange range, java.lang.String message) Creates an annotation with the given severity (colored highlighting only, with no gutter mark and not participating in "Next Error/Warning" navigation) with the specified message over the specified text range.
Annotation	createAnnotation(HighlightSeverity severity, TextRange range, java.lang.String message, java.lang.String tooltip) Creates an annotation with the given severity (colored highlighting only, with no gutter mark and not participating in "Next Error/Warning" navigation) with the specified message and tooltip markup over the specified text range.
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 (colored highlighting only, with no gutter mark and not participating in "Next Error/Warning" navigation) with the specified message over the specified AST node.
Annotation	createInfoAnnotation(PsiElement elt, java.lang.String message) Creates an information annotation (colored highlighting only, with no gutter mark and not participating in "Next Error/Warning" navigation) with the specified message over the specified PSI element.
Annotation	createInfoAnnotation(TextRange range, java.lang.String message) Creates an information annotation (colored highlighting only, with no gutter mark and not participating in "Next Error/Warning" navigation) 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.
Annotation	createWeakWarningAnnotation(ASTNode node, java.lang.String message) Creates an annotation with severity HighlightSeverity.WEAK_WARNING ('weak warning') with the specified message over the specified AST node.
Annotation	createWeakWarningAnnotation(PsiElement elt, java.lang.String message) Creates an annotation with severity HighlightSeverity.WEAK_WARNING ('weak warning') with the specified message over the specified PSI element.
Annotation	createWeakWarningAnnotation(TextRange range, java.lang.String message) Creates an annotation with severity HighlightSeverity.WEAK_WARNING ('weak warning') with the specified message over the specified text range.
AnnotationSession	getCurrentAnnotationSession()
boolean	hasAnnotations()
boolean	isBatchMode()
AnnotationBuilder	newAnnotation(HighlightSeverity severity, java.lang.String message) Begin constructing a new annotation.
AnnotationBuilder	newSilentAnnotation(HighlightSeverity severity) Begin constructing a new annotation with no message.
void	runAnnotatorWithContext(PsiElement element, Annotator annotator)

Methods inherited from class com.intellij.util.SmartList

add, add, clear, contains, equals, forEach, get, getModificationCount, indexOf, iterator, remove, set, size, sort, toArray, trimToSize

Methods inherited from class java.util.AbstractList

addAll, hashCode, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, containsAll, isEmpty, of, of, of, of, of, of, of, of, of, of, of, of, remove, removeAll, replaceAll, retainAll, spliterator, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Constructor Detail

AnnotationHolderImpl

public AnnotationHolderImpl(AnnotationSession session)

Do not instantiate the AnnotationHolderImpl directly, please use the one provided to Annotator.annotate(PsiElement, AnnotationHolder) instead

AnnotationHolderImpl

public AnnotationHolderImpl(AnnotationSession session,
                            boolean batchMode)

Do not instantiate the AnnotationHolderImpl directly, please use the one provided to Annotator.annotate(PsiElement, AnnotationHolder) instead

Method Detail

isBatchMode

public boolean isBatchMode()

Specified by:

isBatchMode in interface AnnotationHolder

createErrorAnnotation

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

Description copied from interface: AnnotationHolder

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

Specified by:

createErrorAnnotation in interface AnnotationHolder

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

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

Description copied from interface: AnnotationHolder

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

Specified by:

createErrorAnnotation in interface AnnotationHolder

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

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

Description copied from interface: AnnotationHolder

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

Specified by:

createErrorAnnotation in interface AnnotationHolder

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

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

Description copied from interface: AnnotationHolder

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

Specified by:

createWarningAnnotation in interface AnnotationHolder

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

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

Description copied from interface: AnnotationHolder

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

Specified by:

createWarningAnnotation in interface AnnotationHolder

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

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

Description copied from interface: AnnotationHolder

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

Specified by:

createWarningAnnotation in interface AnnotationHolder

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)

createWeakWarningAnnotation

public Annotation createWeakWarningAnnotation(PsiElement elt,
                                              java.lang.String message)

Description copied from interface: AnnotationHolder

Creates an annotation with severity HighlightSeverity.WEAK_WARNING ('weak warning') with the specified message over the specified PSI element.

Specified by:

createWeakWarningAnnotation in interface AnnotationHolder

Parameters:

elt - the element over which the annotation is created.

message - the info message.

Returns:

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

createWeakWarningAnnotation

public Annotation createWeakWarningAnnotation(ASTNode node,
                                              java.lang.String message)

Description copied from interface: AnnotationHolder

Creates an annotation with severity HighlightSeverity.WEAK_WARNING ('weak warning') with the specified message over the specified AST node.

Specified by:

createWeakWarningAnnotation in interface AnnotationHolder

Parameters:

node - the node over which the annotation is created.

message - the info message.

Returns:

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

createWeakWarningAnnotation

public Annotation createWeakWarningAnnotation(TextRange range,
                                              java.lang.String message)

Description copied from interface: AnnotationHolder

Creates an annotation with severity HighlightSeverity.WEAK_WARNING ('weak warning') with the specified message over the specified text range.

Specified by:

createWeakWarningAnnotation in interface AnnotationHolder

Parameters:

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

message - the info message.

Returns:

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

createInfoAnnotation

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

Description copied from interface: AnnotationHolder

Creates an information annotation (colored highlighting only, with no gutter mark and not participating in "Next Error/Warning" navigation) with the specified message over the specified PSI element.

Specified by:

createInfoAnnotation in interface AnnotationHolder

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

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

Description copied from interface: AnnotationHolder

Creates an information annotation (colored highlighting only, with no gutter mark and not participating in "Next Error/Warning" navigation) with the specified message over the specified AST node.

Specified by:

createInfoAnnotation in interface AnnotationHolder

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

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

Description copied from interface: AnnotationHolder

Creates an information annotation (colored highlighting only, with no gutter mark and not participating in "Next Error/Warning" navigation) with the specified message over the specified text range.

Specified by:

createInfoAnnotation in interface AnnotationHolder

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)

createAnnotation

public Annotation createAnnotation(HighlightSeverity severity,
                                   TextRange range,
                                   java.lang.String message)

Description copied from interface: AnnotationHolder

Creates an annotation with the given severity (colored highlighting only, with no gutter mark and not participating in "Next Error/Warning" navigation) with the specified message over the specified text range.

Specified by:

createAnnotation in interface AnnotationHolder

Parameters:

severity - the severity.

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)

createAnnotation

public Annotation createAnnotation(HighlightSeverity severity,
                                   TextRange range,
                                   java.lang.String message,
                                   java.lang.String tooltip)

Description copied from interface: AnnotationHolder

Creates an annotation with the given severity (colored highlighting only, with no gutter mark and not participating in "Next Error/Warning" navigation) with the specified message and tooltip markup over the specified text range.

Specified by:

createAnnotation in interface AnnotationHolder

Parameters:

severity - the severity.

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

message - the information message.

tooltip - the tooltip to show (usually the message, but escaped as HTML and surrounded by a <html> tag

Returns:

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

hasAnnotations

public boolean hasAnnotations()

getCurrentAnnotationSession

public AnnotationSession getCurrentAnnotationSession()

Specified by:

getCurrentAnnotationSession in interface AnnotationHolder

newAnnotation

public AnnotationBuilder newAnnotation(HighlightSeverity severity,
                                       java.lang.String message)

Description copied from interface: AnnotationHolder

Begin constructing a new annotation. To finish construction and show the annotation on screen AnnotationBuilder.create() must be called. For example:

holder.newAnnotation(HighlightSeverity.WARNING, "My warning message").create();

Specified by:

newAnnotation in interface AnnotationHolder

Parameters:

severity - The severity of the annotation.

message - The message this annotation will show in the status bar and the tooltip.

newSilentAnnotation

public AnnotationBuilder newSilentAnnotation(HighlightSeverity severity)

Description copied from interface: AnnotationHolder

Begin constructing a new annotation with no message. To finish construction and show the annotation on screen AnnotationBuilder.create() must be called. For example:

holder.newSilentAnnotation(HighlightSeverity.WARNING).textAttributes(MY_ATTRIBUTES_KEY).create();

Specified by:

newSilentAnnotation in interface AnnotationHolder

Parameters:

severity - The severity of the annotation.

runAnnotatorWithContext

public void runAnnotatorWithContext(PsiElement element,
                                    Annotator annotator)

applyExternalAnnotatorWithContext

public <R> void applyExternalAnnotatorWithContext(PsiFile file,
                                                  ExternalAnnotator<?,R> annotator,
                                                  R result)

assertAllAnnotationsCreated

public void assertAllAnnotationsCreated()