Package com.intellij.psi.impl.light

Class LightPsiClassBase

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.psi.impl.light.LightElement

com.intellij.psi.impl.light.LightPsiClassBase

All Implemented Interfaces:

JvmAnnotatedElement, JvmClass, JvmElement, JvmMember, JvmModifiersOwner, JvmNamedElement, JvmTypeDeclaration, JvmTypeParametersOwner, NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, PomNamedTarget, PomRenameableTarget<PsiElement>, PomTarget, NavigatablePsiElement, PsiClass, PsiDocCommentOwner, PsiElement, PsiJavaDocumentedElement, PsiJvmMember, PsiJvmModifiersOwner, PsiMember, PsiModifierListOwner, PsiNamedElement, PsiNameIdentifierOwner, PsiQualifiedNamedElement, PsiTarget, PsiTypeParameterListOwner, SyntheticElement, java.lang.Cloneable

Direct Known Subclasses:

LightPsiClassBuilder

public abstract class LightPsiClassBase
extends LightElement
implements PsiClass, SyntheticElement

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.util.Iconable

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from class com.intellij.psi.impl.light.LightElement

myManager

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

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.PsiClass

ARRAY_FACTORY, 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.openapi.util.Iconable

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Constructor Summary

Constructors

Constructor and Description
LightPsiClassBase(PsiElement context, java.lang.String name)
LightPsiClassBase(PsiManager manager, Language language, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
PsiField	findFieldByName(java.lang.String name, boolean checkBases) Searches the class (and optionally its superclasses) for the field with the specified name.
PsiClass	findInnerClassByName(java.lang.String name, boolean checkBases) Searches the class (and optionally its superclasses) for the inner class with the specified name.
PsiMethod	findMethodBySignature(PsiMethod patternMethod, boolean checkBases) Searches the class (and optionally its superclasses) for the method with the signature matching the signature of the specified method.
java.util.List<Pair<PsiMethod,PsiSubstitutor>>	findMethodsAndTheirSubstitutorsByName(java.lang.String name, boolean checkBases) Searches the class (and optionally its superclasses) for the methods with the specified name and returns the methods along with their substitutors.
PsiMethod []	findMethodsByName(java.lang.String name, boolean checkBases) Searches the class (and optionally its superclasses) for the methods with the specified name.
PsiMethod []	findMethodsBySignature(PsiMethod patternMethod, boolean checkBases) Searches the class (and optionally its superclasses) for the methods with the signature matching the signature of the specified method.
PsiField []	getAllFields() Returns the list of fields in the class and all its superclasses.
PsiClass []	getAllInnerClasses() Returns the list of inner classes for the class and all its superclasses.
PsiMethod []	getAllMethods() Returns the list of methods in the class and all its superclasses.
java.util.List<Pair<PsiMethod,PsiSubstitutor>>	getAllMethodsAndTheirSubstitutors() Returns the list of methods in the class and all its superclasses, along with their substitutors.
PsiMethod []	getConstructors() Returns the list of constructors for the class.
PsiDocComment	getDocComment() Returns the JavaDoc comment for the element, or null when the element has no JavaDoc comment.
PsiClassType []	getExtendsListTypes() Returns the list of class types for the classes that this class or interface extends.
PsiClassType []	getImplementsListTypes() Returns the list of class types for the interfaces that this class implements.
PsiClass []	getInterfaces() Returns the list of interfaces implemented by the class, or extended by the interface.
PsiElement	getLBrace() Returns the token representing the opening curly brace of the class.
abstract PsiModifierList	getModifierList() Returns the list of modifiers for the element.
java.lang.String	getName() Returns the name of the element.
PsiIdentifier	getNameIdentifier() Returns the name identifier of the class.
java.lang.String	getQualifiedName() Returns the fully qualified name of the class.
PsiElement	getRBrace() Returns the token representing the closing curly brace of the class.
PsiClass	getSuperClass() Returns the base class of this class.
PsiClass []	getSupers() Returns the list of classes and interfaces extended or implemented by the class.
PsiClassType []	getSuperTypes() Returns the list of class types for the classes and interfaces extended or implemented by the class.
PsiTypeParameter []	getTypeParameters() Returns the array of type parameters for the element.
java.util.Collection<HierarchicalMethodSignature>	getVisibleSignatures() Returns the hierarchical signatures for all methods in the specified class and its superclasses and superinterfaces.
boolean	hasModifierProperty(java.lang.String name) Checks if the element has the specified modifier.
boolean	hasTypeParameters() Checks if the element has any type parameters.
boolean	isAnnotationType() Checks if the class is an annotation type.
boolean	isDeprecated() Returns true if the element is marked as deprecated via an annotation or a JavaDoc tag.
boolean	isEnum() Checks if the class is an enumeration.
boolean	isInheritor(PsiClass baseClass, boolean checkDeep) Checks if this class is an inheritor of the specified base class.
boolean	isInheritorDeep(PsiClass baseClass, PsiClass classToByPass) Checks if this class is a deep inheritor of the specified base class possibly bypassing a class when checking inheritance chain.
boolean	isInterface() Checks if the class is an interface.
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.
PsiElement	setName(java.lang.String name) Renames the element.
java.lang.String	toString() toString() should never be presented to the user.

Methods inherited from class com.intellij.psi.impl.light.LightElement

accept, add, addAfter, addBefore, checkAdd, checkDelete, copy, delete, findElementAt, getChildren, getContainingFile, getLanguage, getManager, getNavigationElement, getNextSibling, getNode, getParent, getPrevSibling, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, isPhysical, isValid, isWritable, replace, setNavigationElement, textMatches, textMatches, textToCharArray

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

acceptChildren, addRange, addRangeAfter, addRangeBefore, canNavigate, canNavigateToSource, deleteChildRange, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getContext, getFirstChild, getLastChild, getOriginalElement, getPresentation, getProject, getReference, getReferences, getResolveScope, getUseScope, isEquivalentTo, navigate, notNullChild, textContains

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, clone, 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.PsiClass

findMethodsByName, getClassKind, getContainingClass, getExtendsList, getFields, getImplementsList, getInitializers, getInnerClasses, getInterfaceTypes, getMethods, getRecordComponents, getRecordHeader, getScope, getSuperClassType, isRecord

Methods inherited from interface com.intellij.psi.PsiNameIdentifierOwner

getIdentifyingElement

Methods inherited from interface com.intellij.psi.PsiTypeParameterListOwner

getTypeParameterList

Methods inherited from interface com.intellij.navigation.NavigationItem

getPresentation

Methods inherited from interface com.intellij.pom.Navigatable

canNavigate, canNavigateToSource, navigate

Methods inherited from interface com.intellij.psi.PsiJvmModifiersOwner

getAnnotation, getAnnotations, getSourceElement, hasAnnotation, hasModifier

Methods inherited from interface com.intellij.psi.PsiElement

accept, acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getContainingFile, getContext, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNavigationElement, getNextSibling, getNode, getOriginalElement, getOwnReferences, getParent, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, putCopyableUserData, replace, textContains, textMatches, textMatches, textToCharArray

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Methods inherited from interface com.intellij.openapi.util.Iconable

getIcon

Methods inherited from interface com.intellij.psi.PsiTarget

getNavigationElement

Methods inherited from interface com.intellij.pom.PomRenameableTarget

isWritable

Methods inherited from interface com.intellij.pom.PomTarget

isValid

Methods inherited from interface com.intellij.lang.jvm.JvmClass

accept

Constructor Detail

LightPsiClassBase

public LightPsiClassBase(PsiElement context,
                         java.lang.String name)

LightPsiClassBase

public LightPsiClassBase(PsiManager manager,
                         Language language,
                         java.lang.String name)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: PsiNamedElement

Returns the name of the element.

Specified by:

getName in interface JvmClass

Specified by:

getName in interface JvmMember

Specified by:

getName in interface JvmNamedElement

Specified by:

getName in interface NavigationItem

Specified by:

getName in interface PomNamedTarget

Specified by:

getName in interface PsiNamedElement

Specified by:

getName in interface PsiQualifiedNamedElement

Overrides:

getName in class PsiElementBase

Returns:

the element name.

See Also:

Member.getName()

getQualifiedName

public java.lang.String getQualifiedName()

Description copied from interface: PsiClass

Returns the fully qualified name of the class.

Specified by:

getQualifiedName in interface JvmClass

Specified by:

getQualifiedName in interface PsiClass

Specified by:

getQualifiedName in interface PsiQualifiedNamedElement

Returns:

the qualified name of the class, or null for anonymous and local classes, and for type parameters

See Also:

Class.getCanonicalName()

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

Specified by:

toString in class LightElement

isInterface

public boolean isInterface()

Description copied from interface: PsiClass

Checks if the class is an interface.

Specified by:

isInterface in interface PsiClass

Returns:

true if the class is an interface, false otherwise.

isAnnotationType

public boolean isAnnotationType()

Description copied from interface: PsiClass

Checks if the class is an annotation type.

Specified by:

isAnnotationType in interface PsiClass

Returns:

true if the class is an annotation type, false otherwise

isEnum

public boolean isEnum()

Description copied from interface: PsiClass

Checks if the class is an enumeration.

Specified by:

isEnum in interface PsiClass

Returns:

true if the class is an enumeration, false otherwise.

getExtendsListTypes

public PsiClassType [] getExtendsListTypes()

Description copied from interface: PsiClass

Returns the list of class types for the classes that this class or interface extends.

Specified by:

getExtendsListTypes in interface PsiClass

Returns:

the list of extended class types, or an empty list for anonymous classes.

getImplementsListTypes

public PsiClassType [] getImplementsListTypes()

Description copied from interface: PsiClass

Returns the list of class types for the interfaces that this class implements.

Specified by:

getImplementsListTypes in interface PsiClass

Returns:

the list of extended class types, or an empty list for anonymous classes, enums and annotation types

getSuperClass

public PsiClass getSuperClass()

Description copied from interface: PsiClass

Returns the base class of this class.

Specified by:

getSuperClass in interface PsiClass

Returns:

the base class. May return null when jdk is not configured, so no java.lang.Object is found, or for java.lang.Object itself

getInterfaces

public PsiClass [] getInterfaces()

Description copied from interface: PsiClass

Returns the list of interfaces implemented by the class, or extended by the interface.

Specified by:

getInterfaces in interface PsiClass

Returns:

the list of interfaces.

getSupers

public PsiClass [] getSupers()

Description copied from interface: PsiClass

Returns the list of classes and interfaces extended or implemented by the class.

Specified by:

getSupers in interface PsiClass

Returns:

the list of classes or interfaces. May return zero elements when jdk is not configured, so no java.lang.Object is found

getSuperTypes

public PsiClassType [] getSuperTypes()

Description copied from interface: PsiClass

Returns the list of class types for the classes and interfaces extended or implemented by the class.

Specified by:

getSuperTypes in interface PsiClass

Returns:

the list of class types for the classes or interfaces. For the class with no explicit extends list, the returned list always contains at least one element for the java.lang.Object type. If psiClass is java.lang.Object, returned list is empty.

getConstructors

public PsiMethod [] getConstructors()

Description copied from interface: PsiClass

Returns the list of constructors for the class.

Specified by:

getConstructors in interface PsiClass

Returns:

the list of constructors,

getAllFields

public PsiField [] getAllFields()

Description copied from interface: PsiClass

Returns the list of fields in the class and all its superclasses.

Specified by:

getAllFields in interface PsiClass

Returns:

the list of fields.

getAllMethods

public PsiMethod [] getAllMethods()

Description copied from interface: PsiClass

Returns the list of methods in the class and all its superclasses.

Specified by:

getAllMethods in interface PsiClass

Returns:

the list of methods.

getAllInnerClasses

public PsiClass [] getAllInnerClasses()

Description copied from interface: PsiClass

Returns the list of inner classes for the class and all its superclasses.

Specified by:

getAllInnerClasses in interface PsiClass

Returns:

the list of inner classes.

findFieldByName

public PsiField findFieldByName(java.lang.String name,
                                boolean checkBases)

Description copied from interface: PsiClass

Searches the class (and optionally its superclasses) for the field with the specified name.

Specified by:

findFieldByName in interface PsiClass

Parameters:

name - the name of the field to find.

checkBases - if true, the field is also searched in the base classes of the class.

Returns:

the field instance, or null if the field cannot be found.

findMethodBySignature

public PsiMethod findMethodBySignature(PsiMethod patternMethod,
                                       boolean checkBases)

Description copied from interface: PsiClass

Searches the class (and optionally its superclasses) for the method with the signature matching the signature of the specified method.

Specified by:

findMethodBySignature in interface PsiClass

Parameters:

patternMethod - the method used as a pattern for the search.

checkBases - if true, the method is also searched in the base classes of the class.

Returns:

the method instance, or null if the method cannot be found.

findMethodsBySignature

public PsiMethod [] findMethodsBySignature(PsiMethod patternMethod,
                                           boolean checkBases)

Description copied from interface: PsiClass

Searches the class (and optionally its superclasses) for the methods with the signature matching the signature of the specified method. If the superclasses are not searched, the method returns multiple results only in case of a syntax error (duplicate method).

Specified by:

findMethodsBySignature in interface PsiClass

Parameters:

patternMethod - the method used as a pattern for the search.

checkBases - if true, the method is also searched in the base classes of the class.

Returns:

the found methods, or an empty array if no methods are found.

findMethodsByName

public PsiMethod [] findMethodsByName(java.lang.String name,
                                      boolean checkBases)

Description copied from interface: PsiClass

Searches the class (and optionally its superclasses) for the methods with the specified name.

Specified by:

findMethodsByName in interface PsiClass

Parameters:

name - the name of the methods to find.

checkBases - if true, the methods are also searched in the base classes of the class.

Returns:

the found methods, or an empty array if no methods are found.

findMethodsAndTheirSubstitutorsByName

public java.util.List<Pair<PsiMethod,PsiSubstitutor>> findMethodsAndTheirSubstitutorsByName(java.lang.String name,
                                                                                            boolean checkBases)

Description copied from interface: PsiClass

Searches the class (and optionally its superclasses) for the methods with the specified name and returns the methods along with their substitutors.

Specified by:

findMethodsAndTheirSubstitutorsByName in interface PsiClass

Parameters:

name - the name of the methods to find.

checkBases - if true, the methods are also searched in the base classes of the class.

Returns:

the found methods and their substitutors, or an empty list if no methods are found.

getAllMethodsAndTheirSubstitutors

public java.util.List<Pair<PsiMethod,PsiSubstitutor>> getAllMethodsAndTheirSubstitutors()

Description copied from interface: PsiClass

Returns the list of methods in the class and all its superclasses, along with their substitutors.

Specified by:

getAllMethodsAndTheirSubstitutors in interface PsiClass

Returns:

the list of methods and their substitutors

findInnerClassByName

public PsiClass findInnerClassByName(java.lang.String name,
                                     boolean checkBases)

Description copied from interface: PsiClass

Searches the class (and optionally its superclasses) for the inner class with the specified name.

Specified by:

findInnerClassByName in interface PsiClass

Parameters:

name - the name of the inner class to find.

checkBases - if true, the inner class is also searched in the base classes of the class.

Returns:

the inner class instance, or null if the inner class cannot be found.

getLBrace

public PsiElement getLBrace()

Description copied from interface: PsiClass

Returns the token representing the opening curly brace of the class.

Specified by:

getLBrace in interface PsiClass

Returns:

the token instance, or null if the token is missing in the source code file.

getRBrace

public PsiElement getRBrace()

Description copied from interface: PsiClass

Returns the token representing the closing curly brace of the class.

Specified by:

getRBrace in interface PsiClass

Returns:

the token instance, or null if the token is missing in the source code file.

getNameIdentifier

public PsiIdentifier getNameIdentifier()

Description copied from interface: PsiClass

Returns the name identifier of the class.

Specified by:

getNameIdentifier in interface PsiClass

Specified by:

getNameIdentifier in interface PsiNameIdentifierOwner

Returns:

the name identifier, or null if the class is anonymous or synthetic jsp class

isInheritor

public boolean isInheritor(PsiClass baseClass,
                           boolean checkDeep)

Description copied from interface: PsiClass

Checks if this class is an inheritor of the specified base class. Only java inheritance rules are considered. Note that ClassInheritorsSearch may return classes that are inheritors in broader, e.g. in ejb sense, but not in java sense.

Specified by:

isInheritor in interface PsiClass

Parameters:

baseClass - the base class to check the inheritance.

checkDeep - if false, only direct inheritance is checked; if true, the base class is searched in the entire inheritance chain

Returns:

true if the class is an inheritor, false otherwise

isInheritorDeep

public boolean isInheritorDeep(PsiClass baseClass,
                               PsiClass classToByPass)

Description copied from interface: PsiClass

Checks if this class is a deep inheritor of the specified base class possibly bypassing a class when checking inheritance chain. Only java inheritance rules are considered. Note that ClassInheritorsSearch may return classes that are inheritors in broader, e.g. in ejb sense, but not in java sense.

Specified by:

isInheritorDeep in interface PsiClass

Parameters:

baseClass - the base class to check the inheritance. searched in the entire inheritance chain

classToByPass - class to bypass the inheritance check for

Returns:

true if the class is an inheritor, false otherwise

getVisibleSignatures

public java.util.Collection<HierarchicalMethodSignature> getVisibleSignatures()

Description copied from interface: PsiClass

Returns the hierarchical signatures for all methods in the specified class and its superclasses and superinterfaces.

Specified by:

getVisibleSignatures in interface PsiClass

Returns:

the collection of signatures.

setName

public PsiElement setName(java.lang.String name)
                   throws IncorrectOperationException

Description copied from interface: PsiNamedElement

Renames the element.

Specified by:

setName in interface PomRenameableTarget<PsiElement>

Specified by:

setName in interface PsiClass

Specified by:

setName in interface PsiNamedElement

Parameters:

name - the new element name.

Returns:

the element corresponding to this element after the rename (either this or a different element if the rename caused the element to be replaced).

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

getDocComment

public PsiDocComment getDocComment()

Description copied from interface: PsiJavaDocumentedElement

Returns the JavaDoc comment for the element, or null when the element has no JavaDoc comment.

Specified by:

getDocComment in interface PsiJavaDocumentedElement

isDeprecated

public boolean isDeprecated()

Description copied from interface: PsiDocCommentOwner

Returns true if the element is marked as deprecated via an annotation or a JavaDoc tag.

Specified by:

isDeprecated in interface PsiDocCommentOwner

hasTypeParameters

public boolean hasTypeParameters()

Description copied from interface: PsiTypeParameterListOwner

Checks if the element has any type parameters.

Specified by:

hasTypeParameters in interface PsiTypeParameterListOwner

Returns:

true if the element has type parameters, false otherwise

getTypeParameters

public PsiTypeParameter [] getTypeParameters()

Description copied from interface: PsiTypeParameterListOwner

Returns the array of type parameters for the element.

Specified by:

getTypeParameters in interface JvmTypeParametersOwner

Specified by:

getTypeParameters in interface PsiTypeParameterListOwner

Returns:

the array of type parameters, or an empty array if the element has no type parameters.

See Also:

GenericDeclaration.getTypeParameters()

getModifierList

public abstract PsiModifierList getModifierList()

Description copied from interface: PsiModifierListOwner

Returns the list of modifiers for the element.

Specified by:

getModifierList in interface PsiModifierListOwner

Returns:

the list of modifiers, or null if the element (for example, an anonymous inner class) does not have the list of modifiers.

hasModifierProperty

public boolean hasModifierProperty(java.lang.String name)

Description copied from interface: PsiModifierListOwner

Checks if the element has the specified modifier. Possible modifiers are defined as constants in the PsiModifier class.

Specified by:

hasModifierProperty in interface PsiModifierListOwner

Parameters:

name - the name of the modifier to check.

Returns:

true if the element has the modifier, false otherwise

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 PsiElementBase

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.