Package com.intellij.codeInspection.reference

Class RefGraphAnnotator

java.lang.Object

com.intellij.codeInspection.reference.RefGraphAnnotator

Direct Known Subclasses:

RefGraphAnnotatorEx, UnnecessaryModuleDependencyAnnotator

public abstract class RefGraphAnnotator
extends java.lang.Object

Callback which gets called while a reference graph is being built during a global inspection run.

See Also:

GlobalInspectionTool.getAnnotator(com.intellij.codeInspection.reference.RefManager)

Constructor Summary

Constructors

Constructor and Description
RefGraphAnnotator()

Method Summary

Modifier and Type	Method and Description
void	onInitialize(RefElement refElement) Called before the references to the specified element have been collected.
void	onMarkReferenced(PsiElement what, PsiElement from, boolean referencedFromClassInitializer) Called when 'what' element doesn't belong to the selected scope.
void	onMarkReferenced(RefElement refWhat, RefElement refFrom, boolean referencedFromClassInitializer) Called when a reference to the specified element has been found.
void	onMarkReferenced(RefElement refWhat, RefElement refFrom, boolean referencedFromClassInitializer, boolean forReading, boolean forWriting) Called when a reference to the specified element has been found.
void	onMarkReferenced(RefElement refWhat, RefElement refFrom, boolean referencedFromClassInitializer, boolean forReading, boolean forWriting, PsiElement referenceElement) Called when a reference to the specified element has been found.
void	onReferencesBuild(RefElement refElement) Called after the references to the specified element have been collected.

Methods inherited from class java.lang.Object

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

Constructor Detail

RefGraphAnnotator

public RefGraphAnnotator()

Method Detail

onInitialize

public void onInitialize(RefElement refElement)

Called before the references to the specified element have been collected.

Parameters:

refElement - the element the references to which are about to be collected.

onReferencesBuild

public void onReferencesBuild(RefElement refElement)

Called after the references to the specified element have been collected.

Parameters:

refElement - the element the references to which have been collected.

onMarkReferenced

public void onMarkReferenced(RefElement refWhat,
                             RefElement refFrom,
                             boolean referencedFromClassInitializer)

Called when a reference to the specified element has been found.

Parameters:

refWhat - the referenced element.

refFrom - the referencing element.

referencedFromClassInitializer - if true, refFrom is a class and the reference has been found in its initializer block.

onMarkReferenced

public void onMarkReferenced(RefElement refWhat,
                             RefElement refFrom,
                             boolean referencedFromClassInitializer,
                             boolean forReading,
                             boolean forWriting,
                             PsiElement referenceElement)

Called when a reference to the specified element has been found.

Parameters:

refWhat - the referenced element.

refFrom - the referencing element.

referencedFromClassInitializer - if true, refFrom is a class and the reference has been found in its initializer block.

forReading - used for reading

forWriting - used for writing

referenceElement - reference element in refFrom

onMarkReferenced

public void onMarkReferenced(RefElement refWhat,
                             RefElement refFrom,
                             boolean referencedFromClassInitializer,
                             boolean forReading,
                             boolean forWriting)

Called when a reference to the specified element has been found.

Parameters:

refWhat - the referenced element.

refFrom - the referencing element.

referencedFromClassInitializer - if true, refFrom is a class and the reference has been found in its initializer block.

forReading - used for reading

forWriting - used for writing

onMarkReferenced

public void onMarkReferenced(PsiElement what,
                             PsiElement from,
                             boolean referencedFromClassInitializer)

Called when 'what' element doesn't belong to the selected scope.

Parameters:

what - the referenced element

from - the referencing element

referencedFromClassInitializer - if true, refFrom is a class and the reference has been found in its initializer block.