Package com.intellij.compiler.backwardRefs

Interface LanguageCompilerRefAdapter

All Known Implementing Classes:

JavaCompilerRefAdapter

public interface LanguageCompilerRefAdapter

An interface to provide connection between compact internal representation of indexed elements and PSI

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<LanguageCompilerRefAdapter>	EP_NAME
static LanguageCompilerRefAdapter[]	INSTANCES

Method Summary

Modifier and Type	Method and Description
CompilerRef	asCompilerRef(PsiElement element, NameEnumerator names)
static LanguageCompilerRefAdapter	findAdapter(FileType fileType)
static LanguageCompilerRefAdapter	findAdapter(PsiElement element)
static LanguageCompilerRefAdapter	findAdapter(VirtualFile file)
PsiElement []	findDirectInheritorCandidatesInFile(SearchId [] internalNames, PsiFileWithStubSupport file)
PsiElement []	findFunExpressionsInFile(SearchId [] indices, PsiFileWithStubSupport file)
java.util.Set<FileType>	getFileTypes()
java.lang.Class<? extends CompilerRef>	getFunExprClass() functional expression: lambda or method reference.
java.lang.Class<? extends CompilerRef.CompilerClassHierarchyElementDef>	getHierarchyObjectClass() class in java, class or object in some other jvm languages.
java.util.List<CompilerRef>	getHierarchyRestrictedToLibraryScope(CompilerRef baseRef, PsiElement basePsi, NameEnumerator names, GlobalSearchScope libraryScope)
PsiElement []	getInstantiableConstructors(PsiElement aClass)
boolean	isClass(PsiElement element)
boolean	isDirectInheritor(PsiElement candidate, PsiNamedElement baseClass)

Field Detail

EP_NAME

static final ExtensionPointName<LanguageCompilerRefAdapter> EP_NAME

INSTANCES

static final LanguageCompilerRefAdapter[] INSTANCES

Method Detail

findAdapter

static LanguageCompilerRefAdapter findAdapter(VirtualFile file)

findAdapter

static LanguageCompilerRefAdapter findAdapter(FileType fileType)

findAdapter

static LanguageCompilerRefAdapter findAdapter(PsiElement element)

getFileTypes

java.util.Set<FileType> getFileTypes()

asCompilerRef

CompilerRef asCompilerRef(PsiElement element,
                          NameEnumerator names)
                   throws java.io.IOException

Parameters:

element - PSI element written in corresponding language

names - enumerator to encode string names

Returns:

Throws:

java.io.IOException

getHierarchyRestrictedToLibraryScope

java.util.List<CompilerRef> getHierarchyRestrictedToLibraryScope(CompilerRef baseRef,
                                                                 PsiElement basePsi,
                                                                 NameEnumerator names,
                                                                 GlobalSearchScope libraryScope)
                                                          throws java.io.IOException

Returns:

"hierarchy" of given element inside the libraries scope.

Throws:

java.io.IOException

getHierarchyObjectClass

java.lang.Class<? extends CompilerRef.CompilerClassHierarchyElementDef> getHierarchyObjectClass()

class in java, class or object in some other jvm languages. used in direct inheritor search. This class object will be used to filter inheritors of corresponding language among of other inheritors. name of this CompilerRef is always enumerated internal string name of language object, eg.: A$1$B

getFunExprClass

java.lang.Class<? extends CompilerRef> getFunExprClass()

functional expression: lambda or method reference. used in functional expression search name of this CompilerRef is always order-index inside source-code file

findDirectInheritorCandidatesInFile

PsiElement [] findDirectInheritorCandidatesInFile(SearchId [] internalNames,
                                                  PsiFileWithStubSupport file)

Returns:

classes that can be inheritors of given superClass. This method shouldn't directly check are found elements really inheritors.

findFunExpressionsInFile

PsiElement [] findFunExpressionsInFile(SearchId [] indices,
                                       PsiFileWithStubSupport file)

Parameters:

indices - - ordinal-numbers (corresponding to compiler tree index visitor) of required functional expressions.

Returns:

functional expressions for given functional type. Should return

isClass

boolean isClass(PsiElement element)

getInstantiableConstructors

PsiElement [] getInstantiableConstructors(PsiElement aClass)

isDirectInheritor

boolean isDirectInheritor(PsiElement candidate,
                          PsiNamedElement baseClass)