Package com.intellij.psi.impl.source

Class PsiCodeFragmentImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.source.PsiFileImpl

com.intellij.psi.impl.source.PsiCodeFragmentImpl

All Implemented Interfaces:

NavigationItem, Queryable, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, PsiFileEx, PsiFileWithStubSupport, IntentionFilterOwner, JavaCodeFragment, NavigatablePsiElement, PsiCheckedRenameElement, PsiCodeFragment, PsiElement, PsiFile, PsiFileSystemItem, PsiImportHolder, PsiNamedElement, java.lang.Cloneable

Direct Known Subclasses:

PsiExpressionCodeFragmentImpl, PsiJavaCodeReferenceCodeFragmentImpl, PsiTypeCodeFragmentImpl

public class PsiCodeFragmentImpl
extends PsiFileImpl
implements JavaCodeFragment, IntentionFilterOwner

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.psi.JavaCodeFragment

JavaCodeFragment.ExceptionHandler, JavaCodeFragment.VisibilityChecker

Nested classes/interfaces inherited from interface com.intellij.psi.IntentionFilterOwner

IntentionFilterOwner.IntentionActionsFilter

Nested classes/interfaces inherited from interface com.intellij.openapi.ui.Queryable

Queryable.Contributor, Queryable.PrintInfo, Queryable.Util

Field Summary

Fields inherited from class com.intellij.psi.impl.source.PsiFileImpl

BUILDING_STUB, myContentElementType, myManager, myOriginalFile

Fields inherited from class com.intellij.psi.impl.ElementBase

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.PsiFile

EMPTY_ARRAY

Fields inherited from interface com.intellij.psi.NavigatablePsiElement

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Fields inherited from interface com.intellij.psi.impl.PsiFileEx

BATCH_REFERENCE_PROCESSING

Constructor Summary

Constructors

Constructor and Description
PsiCodeFragmentImpl(Project project, IElementType contentElementType, boolean isPhysical, java.lang.String name, java.lang.CharSequence text, PsiElement context)

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
void	addImportsFromString(java.lang.String imports) Adds the specified classes to the list of classes considered to be imported by the code fragment.
protected PsiCodeFragmentImpl	clone()
void	forceResolveScope(GlobalSearchScope scope) Force search scope for this fragment
PsiElement	getContext() Returns the element which should be used as the parent of this element in a tree up walk during a resolve operation.
JavaCodeFragment.ExceptionHandler	getExceptionHandler() Gets the exception handler which is used to determine which exceptions are considered handled in the context where the fragment is used.
FileType	getFileType() Returns the file type for the file.
GlobalSearchScope	getForcedResolveScope()
IntentionFilterOwner.IntentionActionsFilter	getIntentionActionsFilter() Sets the intention actions filter which is used to determine which intention actions should be available in an editor.
Language	getLanguage() Returns the language of the PSI element.
GlobalSearchScope	getResolveScope() Returns the scope in which the declarations for the references in this PSI element are searched.
PsiType	getSuperType() Returns the type corresponding to the super keyword in the code fragment.
PsiType	getThisType() Returns the type corresponding to the this keyword in the code fragment.
FileViewProvider	getViewProvider()
JavaCodeFragment.VisibilityChecker	getVisibilityChecker() Gets the visibility checker which is used to determine the visibility of declarations from the code fragment.
boolean	importClass(PsiClass aClass) Adds an import statement for importing the specified class.
java.lang.String	importsToString() Returns the list of classes considered to be imported by the code fragment.
boolean	isPhysical() Checks if an actual source or class file corresponds to the element.
boolean	processDeclarations(PsiScopeProcessor processor, ResolveState state, PsiElement lastParent, PsiElement place) Passes the declarations contained in this PSI element and its children for processing to the specified scope processor.
void	setExceptionHandler(JavaCodeFragment.ExceptionHandler exceptionHandler) Sets the exception handler which is used to determine which exceptions are considered handled in the context where the fragment is used.
void	setIntentionActionsFilter(IntentionFilterOwner.IntentionActionsFilter filter) Sets the intention actions filter which is used to determine which intention actions should be available in an editor.
void	setSuperType(PsiType superType) Sets the type corresponding to the super keyword in the code fragment.
void	setThisType(PsiType psiType) Sets the type corresponding to the this keyword in the code fragment.
void	setVisibilityChecker(JavaCodeFragment.VisibilityChecker checker) Sets the visibility checker which is used to determine the visibility of declarations from the code fragment.
java.lang.String	toString() toString() should never be presented to the user.

Methods inherited from class com.intellij.psi.impl.source.PsiFileImpl

acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, assertReadAccessAllowed, beforeAstChange, calcStubTree, calcTreeElement, canNavigate, canNavigateToSource, checkAdd, checkDelete, checkSetName, clearCaches, cloneImpl, copy, createContentLeafElement, createFileElement, delete, deleteChildRange, derefStub, findChildByClass, findChildrenByClass, findElementAt, findReferenceAt, getChildren, getContainingDirectory, getContainingFile, getContentElementType, getElementTypeForStubBuilder, getFileElementType, getFirstChild, getGreenStub, getGreenStubTree, getLastChild, getManager, getModificationStamp, getName, getNavigationElement, getNextSibling, getNode, getOriginalElement, getOriginalFile, getParent, getPresentation, getPrevSibling, getProject, getPsiRoots, getReference, getReferences, getStartOffsetInParent, getStub, getStubbedSpine, getStubTree, getText, getTextLength, getTextOffset, getTextRange, getTreeElement, getUseScope, getVirtualFile, init, isContentsLoaded, isDirectory, isEquivalentTo, isTemplateDataFile, isValid, isWritable, markInvalidated, navigate, onContentReload, processChildren, putInfo, putInfo, replace, setContentElementType, setName, setOriginalFile, setTreeElementPointer, subtreeChanged, textContains, textMatches, textMatches, textToCharArray

Methods inherited from class com.intellij.psi.impl.ElementBase

buildRowIcon, computeBaseIcon, createLayeredIcon, getAdjustedBaseIcon, getBaseIcon, getElementIcon, getIcon, iconWithVisibilityIfNeeded, isNativeFileType, isVisibilitySupported, overlayIcons, registerIconLayer, transformFlags

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.psi.PsiFile

clearCaches, getContainingDirectory, getFileElementType, getModificationStamp, getNode, getOriginalFile, getParent, getPsiRoots, getVirtualFile, subtreeChanged

Methods inherited from interface com.intellij.psi.PsiFileSystemItem

getName, isDirectory, processChildren

Methods inherited from interface com.intellij.psi.PsiCheckedRenameElement

checkSetName

Methods inherited from interface com.intellij.psi.PsiNamedElement

setName

Methods inherited from interface com.intellij.navigation.NavigationItem

getPresentation

Methods inherited from interface com.intellij.pom.Navigatable

canNavigate, canNavigateToSource, navigate

Constructor Detail

PsiCodeFragmentImpl

public PsiCodeFragmentImpl(Project project,
                           IElementType contentElementType,
                           boolean isPhysical,
                           java.lang.String name,
                           java.lang.CharSequence text,
                           PsiElement context)

Method Detail

getLanguage

public Language getLanguage()

Description copied from interface: PsiElement

Returns the language of the PSI element.

Specified by:

getLanguage in interface PsiElement

Overrides:

getLanguage in class PsiFileImpl

Returns:

the language instance.

clone

protected PsiCodeFragmentImpl clone()

Overrides:

clone in class PsiFileImpl

getViewProvider

public FileViewProvider getViewProvider()

Specified by:

getViewProvider in interface PsiFile

Overrides:

getViewProvider in class PsiFileImpl

getFileType

public FileType getFileType()

Description copied from interface: PsiFile

Returns the file type for the file.

Specified by:

getFileType in interface PsiFile

Returns:

the file type instance.

getContext

public PsiElement getContext()

Description copied from interface: PsiElement

Returns the element which should be used as the parent of this element in a tree up walk during a resolve operation. For most elements, this returns getParent(), but the context can be overridden for some elements like code fragments (see JavaCodeFragmentFactory.createCodeBlockCodeFragment(String, PsiElement, boolean)).

Specified by:

getContext in interface PsiElement

Overrides:

getContext in class PsiFileImpl

Returns:

the resolve context element.

getThisType

public PsiType getThisType()

Description copied from interface: JavaCodeFragment

Returns the type corresponding to the this keyword in the code fragment.

Specified by:

getThisType in interface JavaCodeFragment

Returns:

the type of this in the fragment.

setThisType

public void setThisType(PsiType psiType)

Description copied from interface: JavaCodeFragment

Sets the type corresponding to the this keyword in the code fragment.

Specified by:

setThisType in interface JavaCodeFragment

Parameters:

psiType - the type of this in the fragment.

getSuperType

public PsiType getSuperType()

Description copied from interface: JavaCodeFragment

Returns the type corresponding to the super keyword in the code fragment.

Specified by:

getSuperType in interface JavaCodeFragment

Returns:

the type of super in the fragment.

setSuperType

public void setSuperType(PsiType superType)

Description copied from interface: JavaCodeFragment

Sets the type corresponding to the super keyword in the code fragment.

Specified by:

setSuperType in interface JavaCodeFragment

Parameters:

superType - the type of super in the fragment.

importsToString

public java.lang.String importsToString()

Description copied from interface: JavaCodeFragment

Returns the list of classes considered to be imported by the code fragment.

Specified by:

importsToString in interface JavaCodeFragment

Returns:

the comma-separated list of full-qualified names of classes considered to be imported.

addImportsFromString

public void addImportsFromString(java.lang.String imports)

Description copied from interface: JavaCodeFragment

Adds the specified classes to the list of classes considered to be imported by the code fragment.

Specified by:

addImportsFromString in interface JavaCodeFragment

Parameters:

imports - the comma-separated list of full-qualified names of classes to import.

setVisibilityChecker

public void setVisibilityChecker(JavaCodeFragment.VisibilityChecker checker)

Description copied from interface: JavaCodeFragment

Sets the visibility checker which is used to determine the visibility of declarations from the code fragment.

Specified by:

setVisibilityChecker in interface JavaCodeFragment

Parameters:

checker - the checker instance.

getVisibilityChecker

public JavaCodeFragment.VisibilityChecker getVisibilityChecker()

Description copied from interface: JavaCodeFragment

Gets the visibility checker which is used to determine the visibility of declarations from the code fragment.

Specified by:

getVisibilityChecker in interface JavaCodeFragment

Returns:

the checker instance.

isPhysical

public boolean isPhysical()

Description copied from interface: PsiElement

Checks if an actual source or class file corresponds to the element. Non-physical elements include, for example, PSI elements created for the watch expressions in the debugger. Non-physical elements do not generate tree change events. Also, PsiDocumentManager.getDocument(PsiFile) returns null for non-physical elements. Not to be confused with FileViewProvider.isPhysical().

Specified by:

isPhysical in interface PsiElement

Overrides:

isPhysical in class PsiFileImpl

Returns:

true if the element is physical, false otherwise.

accept

public void accept(PsiElementVisitor visitor)

Description copied from interface: PsiElement

Passes the element to the specified visitor.

Specified by:

accept in interface PsiElement

Parameters:

visitor - the visitor to pass the element to.

processDeclarations

public boolean processDeclarations(PsiScopeProcessor processor,
                                   ResolveState state,
                                   PsiElement lastParent,
                                   PsiElement place)

Description copied from interface: PsiElement

Passes the declarations contained in this PSI element and its children for processing to the specified scope processor.

Specified by:

processDeclarations in interface PsiElement

Overrides:

processDeclarations in class PsiFileImpl

Parameters:

processor - the processor receiving the declarations.

lastParent - the child of this element has been processed during the previous step of the tree up walk (declarations under this element do not need to be processed again)

place - the original element from which the tree up walk was initiated.

Returns:

true if the declaration processing should continue or false if it should be stopped.

toString

public java.lang.String toString()

Description copied from interface: PsiElement

toString() should never be presented to the user.

Specified by:

toString in interface PsiElement

Overrides:

toString in class PsiFileImpl

importClass

public boolean importClass(PsiClass aClass)

Description copied from interface: PsiImportHolder

Adds an import statement for importing the specified class.

Specified by:

importClass in interface PsiImportHolder

Parameters:

aClass - the class to import.

Returns:

true if the import statement was added successfully, false otherwise.

getExceptionHandler

public JavaCodeFragment.ExceptionHandler getExceptionHandler()

Description copied from interface: JavaCodeFragment

Gets the exception handler which is used to determine which exceptions are considered handled in the context where the fragment is used.

Specified by:

getExceptionHandler in interface JavaCodeFragment

Returns:

the exception handler instance.

setIntentionActionsFilter

public void setIntentionActionsFilter(IntentionFilterOwner.IntentionActionsFilter filter)

Description copied from interface: IntentionFilterOwner

Sets the intention actions filter which is used to determine which intention actions should be available in an editor.

Specified by:

setIntentionActionsFilter in interface IntentionFilterOwner

Parameters:

filter - the intention actions filter instance.

getIntentionActionsFilter

public IntentionFilterOwner.IntentionActionsFilter getIntentionActionsFilter()

Description copied from interface: IntentionFilterOwner

Sets the intention actions filter which is used to determine which intention actions should be available in an editor.

Specified by:

getIntentionActionsFilter in interface IntentionFilterOwner

Returns:

the intention actions filter instance.

forceResolveScope

public void forceResolveScope(GlobalSearchScope scope)

Description copied from interface: PsiCodeFragment

Force search scope for this fragment

Specified by:

forceResolveScope in interface PsiCodeFragment

Parameters:

scope - Scope to use when resolving references in this context

getForcedResolveScope

public GlobalSearchScope getForcedResolveScope()

Specified by:

getForcedResolveScope in interface PsiCodeFragment

getResolveScope

public GlobalSearchScope getResolveScope()

Description copied from interface: PsiElement

Returns the scope in which the declarations for the references in this PSI element are searched.

Specified by:

getResolveScope in interface PsiElement

Overrides:

getResolveScope in class PsiFileImpl

Returns:

the resolve scope instance.

setExceptionHandler

public void setExceptionHandler(JavaCodeFragment.ExceptionHandler exceptionHandler)

Description copied from interface: JavaCodeFragment

Sets the exception handler which is used to determine which exceptions are considered handled in the context where the fragment is used.

Specified by:

setExceptionHandler in interface JavaCodeFragment

Parameters:

exceptionHandler - the exception handler instance.