Package com.intellij.compiler

Interface CompilerReferenceService

All Superinterfaces:

BaseComponent, NamedComponent, ProjectComponent

All Known Subinterfaces:

CompilerReferenceServiceEx

All Known Implementing Classes:

CompilerReferenceServiceBase, CompilerReferenceServiceImpl

public interface CompilerReferenceService
extends ProjectComponent

The service is intended to provide an information about class/method/field usages or classes hierarchy that is obtained on compilation time. It means that this service should not affect any find usages result when initial project is not compiled or project language is not supported by LanguageCompilerRefAdapter extension. Any result provided by this service should be valid even if some part of a given project was modified after compilation.

Field Summary

Fields

Modifier and Type	Field and Description
static RegistryValue	IS_ENABLED_KEY

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getCompileTimeOccurrenceCount(PsiElement element, boolean isConstructorCompletion)
CompilerDirectHierarchyInfo	getDirectInheritors(PsiNamedElement aClass, GlobalSearchScope searchScope, FileType searchFileType)
CompilerDirectHierarchyInfo	getFunExpressions(PsiNamedElement functionalInterface, GlobalSearchScope searchScope, FileType searchFileType)
static CompilerReferenceService	getInstance(Project project)
GlobalSearchScope	getScopeWithoutCodeReferences(PsiElement element)
GlobalSearchScope	getScopeWithoutImplicitToStringCodeReferences(PsiElement aClass)
boolean	isActive()
static boolean	isEnabled()

Methods inherited from interface com.intellij.openapi.components.ProjectComponent

projectClosed, projectOpened

Methods inherited from interface com.intellij.openapi.components.BaseComponent

disposeComponent, initComponent

Methods inherited from interface com.intellij.openapi.components.NamedComponent

getComponentName

Field Detail

IS_ENABLED_KEY

static final RegistryValue IS_ENABLED_KEY

Method Detail

getInstance

static CompilerReferenceService getInstance(Project project)

getScopeWithoutCodeReferences

GlobalSearchScope getScopeWithoutCodeReferences(PsiElement element)

Returns:

a scope where given element has no references in code. This scope might be not a strict scope where element is not occurred.

getScopeWithoutImplicitToStringCodeReferences

GlobalSearchScope getScopeWithoutImplicitToStringCodeReferences(PsiElement aClass)

getDirectInheritors

CompilerDirectHierarchyInfo getDirectInheritors(PsiNamedElement aClass,
                                                GlobalSearchScope searchScope,
                                                FileType searchFileType)

Returns:

a hierarchy of direct inheritors built on compilation time. This hierarchy is restricted by searchFileType and searchScope.

getFunExpressions

CompilerDirectHierarchyInfo getFunExpressions(PsiNamedElement functionalInterface,
                                              GlobalSearchScope searchScope,
                                              FileType searchFileType)

Returns:

a stream of functional expressions that implement given functional interface. This hierarchy is restricted by searchFileType and searchScope.

getCompileTimeOccurrenceCount

java.lang.Integer getCompileTimeOccurrenceCount(PsiElement element,
                                                boolean isConstructorCompletion)

Returns:

count of references that were observed on compile-time (in the last compilation) or null if given element is not supported for some reason.

isActive

boolean isActive()

isEnabled

static boolean isEnabled()