PsiClass (Unofficial IntelliJ Community Edition API docs)

All Superinterfaces:

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

All Known Subinterfaces:

GrAnnotationTypeDefinition, GrAnonymousClassDefinition, GrClassDefinition, GrEnumConstantInitializer, GrEnumTypeDefinition, GrInterfaceDefinition, GrTraitTypeDefinition, GrTypeDefinition, GrTypeParameter, JspClass, PsiAnonymousClass, PsiEnumConstantInitializer, PsiExtensibleClass, PsiJShellRootClass, PsiSyntheticClass, PsiTypeParameter

All Known Implementing Classes:

AbstractLightClass, BuilderHelperLightPsiClass, ClsClassImpl, ClsTypeParameterImpl, GrAnnotationTypeDefinitionImpl, GrAnonymousClassDefinitionImpl, GrClassDefinitionImpl, GrEnumConstantInitializerImpl, GrEnumTypeDefinitionImpl, GrInterfaceDefinitionImpl, GrLightTypeDefinitionBase, GroovyScriptClass, GrTraitTypeDefinitionImpl, GrTypeDefinitionImpl, GrTypeParameterImpl, InferenceVariable, LightClass, LightPsiClassBase, LightPsiClassBuilder, LightTypeParameter, LightTypeParameterBuilder, MigrationClassImpl, PsiAnonymousClassImpl, PsiClassImpl, PsiEnumConstantInitializerImpl, PsiJShellRootClassImpl, PsiTypeParameterImpl
```
public interface PsiClass
extends PsiNameIdentifierOwner, PsiModifierListOwner, PsiDocCommentOwner, PsiTypeParameterListOwner, PsiQualifiedNamedElement, PsiTarget, PomRenameableTarget<PsiElement>, JvmClass
```
Represents a Java class or interface.

See Also:

PsiClassOwner.getClasses()

Nested Class Summary
- Nested classes/interfaces inherited from interface com.intellij.openapi.util.Iconable
  Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields
Modifier and Type	Field and Description
`static ArrayFactory<PsiClass>`	`ARRAY_FACTORY`
`static PsiClass []`	`EMPTY_ARRAY` The empty array of PSI classes which can be reused to avoid unnecessary allocations.

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
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.
`default JvmMethod []`	`findMethodsByName(java.lang.String methodName)`
`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.
`default JvmClassKind`	`getClassKind()`
`PsiMethod []`	`getConstructors()` Returns the list of constructors for the class.
`PsiClass`	`getContainingClass()` For an inner class, returns its containing class.
`PsiReferenceList`	`getExtendsList()` Returns the list of classes that this class or interface extends.
`PsiClassType []`	`getExtendsListTypes()` Returns the list of class types for the classes that this class or interface extends.
`PsiField []`	`getFields()` Returns the list of fields in the class.
`PsiReferenceList`	`getImplementsList()` Returns the list of interfaces that this class implements.
`PsiClassType []`	`getImplementsListTypes()` Returns the list of class types for the interfaces that this class implements.
`PsiClassInitializer []`	`getInitializers()` Returns the list of class initializers for the class.
`PsiClass []`	`getInnerClasses()` Returns the list of inner classes for the class.
`PsiClass []`	`getInterfaces()` Returns the list of interfaces implemented by the class, or extended by the interface.
`default JvmReferenceType []`	`getInterfaceTypes()`
`PsiElement`	`getLBrace()` Returns the token representing the opening curly brace of the class.
`PsiMethod []`	`getMethods()` Returns the list of methods in the class.
`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.
`default PsiRecordComponent []`	`getRecordComponents()`
`default PsiRecordHeader`	`getRecordHeader()`
`PsiElement`	`getScope()` Returns the PSI member in which the class has been declared (for example, the method containing the anonymous inner class, or the file containing a regular class, or the class owning a type parameter).
`PsiClass`	`getSuperClass()` Returns the base class of this class.
`default JvmReferenceType`	`getSuperClassType()`
`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.
`java.util.Collection<HierarchicalMethodSignature>`	`getVisibleSignatures()` Returns the hierarchical signatures for all methods in the specified class and its superclasses and superinterfaces.
`boolean`	`isAnnotationType()` Checks if the class is an annotation type.
`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.
`default boolean`	`isRecord()` Checks if the class is a record.
`PsiElement`	`setName(java.lang.String name)` Renames the element.

Methods inherited from interface com.intellij.psi.PsiNameIdentifierOwner
getIdentifyingElement

Methods inherited from interface com.intellij.psi.PsiDocCommentOwner
isDeprecated

Methods inherited from interface com.intellij.psi.PsiJavaDocumentedElement
getDocComment

Methods inherited from interface com.intellij.psi.PsiTypeParameterListOwner
getTypeParameterList, getTypeParameters, hasTypeParameters

Methods inherited from interface com.intellij.navigation.NavigationItem
getName, 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.PsiModifierListOwner
getModifierList, hasModifierProperty

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.PsiQualifiedNamedElement
getName

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.PomNamedTarget
getName

Methods inherited from interface com.intellij.pom.PomTarget
isValid

Methods inherited from interface com.intellij.lang.jvm.JvmClass
accept, getName

- Field Detail
  - EMPTY_ARRAY
```
static final PsiClass [] EMPTY_ARRAY
```
    The empty array of PSI classes which can be reused to avoid unnecessary allocations.
  - ARRAY_FACTORY
```
static final ArrayFactory<PsiClass> ARRAY_FACTORY
```
- Method Detail
  - getQualifiedName
```
java.lang.String getQualifiedName()
```
    Returns the fully qualified name of the class.
    
    Specified by:
    
    getQualifiedName in interface JvmClass
    
    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()
  - isInterface
```
boolean isInterface()
```
    Checks if the class is an interface.
    
    Returns:
    
    true if the class is an interface, false otherwise.
  - isAnnotationType
```
boolean isAnnotationType()
```
    Checks if the class is an annotation type.
    
    Returns:
    
    true if the class is an annotation type, false otherwise
  - isEnum
```
boolean isEnum()
```
    Checks if the class is an enumeration.
    
    Returns:
    
    true if the class is an enumeration, false otherwise.
  - isRecord
```
default boolean isRecord()
```
    Checks if the class is a record.
    
    Returns:
    
    true if the class is an record, false otherwise.
  - getExtendsList
```
PsiReferenceList getExtendsList()
```
    Returns the list of classes that this class or interface extends.
    
    Returns:
    
    the extends list, or null for anonymous classes.
  - getImplementsList
```
PsiReferenceList getImplementsList()
```
    Returns the list of interfaces that this class implements.
    
    Returns:
    
    the implements list, or null for anonymous classes
  - getExtendsListTypes
```
PsiClassType [] getExtendsListTypes()
```
    Returns the list of class types for the classes that this class or interface extends.
    
    Returns:
    
    the list of extended class types, or an empty list for anonymous classes.
  - getImplementsListTypes
```
PsiClassType [] getImplementsListTypes()
```
    Returns the list of class types for the interfaces that this class implements.
    
    Returns:
    
    the list of extended class types, or an empty list for anonymous classes, enums and annotation types
  - getSuperClass
```
PsiClass getSuperClass()
```
    Returns the base class of this class.
    
    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
```
PsiClass [] getInterfaces()
```
    Returns the list of interfaces implemented by the class, or extended by the interface.
    
    Returns:
    
    the list of interfaces.
  - getSupers
```
PsiClass [] getSupers()
```
    Returns the list of classes and interfaces extended or implemented by the class.
    
    Returns:
    
    the list of classes or interfaces. May return zero elements when jdk is not configured, so no java.lang.Object is found
  - getSuperTypes
```
PsiClassType [] getSuperTypes()
```
    Returns the list of class types for the classes and interfaces extended or implemented by the class.
    
    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.
  - getFields
```
PsiField [] getFields()
```
    Returns the list of fields in the class.
    
    Specified by:
    
    getFields in interface JvmClass
    
    Returns:
    
    the list of fields.
    
    See Also:
    
    Class.getDeclaredFields()
  - getMethods
```
PsiMethod [] getMethods()
```
    Returns the list of methods in the class.
    
    Specified by:
    
    getMethods in interface JvmClass
    
    Returns:
    
    the list of methods.
    
    See Also:
    
    Class.getDeclaredMethods(), Class.getDeclaredConstructors()
  - getConstructors
```
PsiMethod [] getConstructors()
```
    Returns the list of constructors for the class.
    
    Returns:
    
    the list of constructors,
  - getInnerClasses
```
PsiClass [] getInnerClasses()
```
    Returns the list of inner classes for the class.
    
    Specified by:
    
    getInnerClasses in interface JvmClass
    
    Returns:
    
    the list of inner classes.
    
    See Also:
    
    Class.getDeclaredClasses()
  - getInitializers
```
PsiClassInitializer [] getInitializers()
```
    Returns the list of class initializers for the class.
    
    Returns:
    
    the list of class initializers.
  - getAllFields
```
PsiField [] getAllFields()
```
    Returns the list of fields in the class and all its superclasses.
    
    Returns:
    
    the list of fields.
  - getAllMethods
```
PsiMethod [] getAllMethods()
```
    Returns the list of methods in the class and all its superclasses.
    
    Returns:
    
    the list of methods.
  - getAllInnerClasses
```
PsiClass [] getAllInnerClasses()
```
    Returns the list of inner classes for the class and all its superclasses.
    
    Returns:
    
    the list of inner classes.
  - findFieldByName
```
PsiField findFieldByName(java.lang.String name,
                         boolean checkBases)
```
    Searches the class (and optionally its superclasses) for the field with the specified name.
    
    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
```
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.
    
    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
```
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. If the superclasses are not searched, the method returns multiple results only in case of a syntax error (duplicate method).
    
    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
```
default JvmMethod [] findMethodsByName(java.lang.String methodName)
```
    Specified by:
    
    findMethodsByName in interface JvmClass
    
    Returns:
    
    methods (excluding inherited) with the specified name
    
    See Also:
    
    Class.getDeclaredMethod(java.lang.String, java.lang.Class<?>...)
  - findMethodsByName
```
PsiMethod [] findMethodsByName(java.lang.String name,
                               boolean checkBases)
```
    Searches the class (and optionally its superclasses) for the methods with the specified name.
    
    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
```
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.
    
    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
```
java.util.List<Pair<PsiMethod,PsiSubstitutor>> getAllMethodsAndTheirSubstitutors()
```
    Returns the list of methods in the class and all its superclasses, along with their substitutors.
    
    Returns:
    
    the list of methods and their substitutors
  - findInnerClassByName
```
PsiClass findInnerClassByName(java.lang.String name,
                              boolean checkBases)
```
    Searches the class (and optionally its superclasses) for the inner class with the specified name.
    
    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
```
PsiElement getLBrace()
```
    Returns the token representing the opening curly brace of the class.
    
    Returns:
    
    the token instance, or null if the token is missing in the source code file.
  - getRBrace
```
PsiElement getRBrace()
```
    Returns the token representing the closing curly brace of the class.
    
    Returns:
    
    the token instance, or null if the token is missing in the source code file.
  - getNameIdentifier
```
PsiIdentifier getNameIdentifier()
```
    Returns the name identifier of the class.
    
    Specified by:
    
    getNameIdentifier in interface PsiNameIdentifierOwner
    
    Returns:
    
    the name identifier, or null if the class is anonymous or synthetic jsp class
  - getScope
```
PsiElement getScope()
```
    Returns the PSI member in which the class has been declared (for example, the method containing the anonymous inner class, or the file containing a regular class, or the class owning a type parameter).
    
    Returns:
    
    the member in which the class has been declared.
  - isInheritor
```
boolean isInheritor(PsiClass baseClass,
                    boolean checkDeep)
```
    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.
    
    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
```
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. 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.
    
    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
  - getContainingClass
```
PsiClass getContainingClass()
```
    For an inner class, returns its containing class.
    
    Specified by:
    
    getContainingClass in interface JvmMember
    
    Specified by:
    
    getContainingClass in interface PsiJvmMember
    
    Specified by:
    
    getContainingClass in interface PsiMember
    
    Returns:
    
    the containing class, or null if the class is not an inner class.
    
    See Also:
    
    Member.getDeclaringClass()
  - getVisibleSignatures
```
java.util.Collection<HierarchicalMethodSignature> getVisibleSignatures()
```
    Returns the hierarchical signatures for all methods in the specified class and its superclasses and superinterfaces.
    
    Returns:
    
    the collection of signatures.
  - setName
```
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 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.
  - getClassKind
```
default JvmClassKind getClassKind()
```
    Specified by:
    
    getClassKind in interface JvmClass
  - getSuperClassType
```
default JvmReferenceType getSuperClassType()
```
    Specified by:
    
    getSuperClassType in interface JvmClass
    
    Returns:
    
    direct super type or null if this class is an interface or represents Object
    
    See Also:
    
    Class.getSuperclass(), Class.getGenericSuperclass(), Class.getAnnotatedSuperclass()
  - getInterfaceTypes
```
default JvmReferenceType [] getInterfaceTypes()
```
    Specified by:
    
    getInterfaceTypes in interface JvmClass
    
    Returns:
    
    interface types which are directly implemented by this class
    
    See Also:
    
    Class.getInterfaces(), Class.getAnnotatedInterfaces(), Class.getGenericInterfaces()
  - getRecordComponents
```
default PsiRecordComponent [] getRecordComponents()
```
  - getRecordHeader
```
default PsiRecordHeader getRecordHeader()
```

Interface PsiClass

Nested Class Summary

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

Field Summary

Fields inherited from interface com.intellij.psi.NavigatablePsiElement

Fields inherited from interface com.intellij.navigation.NavigationItem

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

Method Summary

Methods inherited from interface com.intellij.psi.PsiNameIdentifierOwner

Methods inherited from interface com.intellij.psi.PsiDocCommentOwner

Methods inherited from interface com.intellij.psi.PsiJavaDocumentedElement

Methods inherited from interface com.intellij.psi.PsiTypeParameterListOwner

Methods inherited from interface com.intellij.navigation.NavigationItem

Methods inherited from interface com.intellij.pom.Navigatable

Methods inherited from interface com.intellij.psi.PsiJvmModifiersOwner

Methods inherited from interface com.intellij.psi.PsiModifierListOwner

Methods inherited from interface com.intellij.psi.PsiElement

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

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

Methods inherited from interface com.intellij.psi.PsiQualifiedNamedElement

Methods inherited from interface com.intellij.psi.PsiTarget

Methods inherited from interface com.intellij.pom.PomRenameableTarget

Methods inherited from interface com.intellij.pom.PomNamedTarget

Methods inherited from interface com.intellij.pom.PomTarget

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

Field Detail

EMPTY_ARRAY

ARRAY_FACTORY

Method Detail

getQualifiedName

isInterface

isAnnotationType

isEnum

isRecord

getExtendsList

getImplementsList

getExtendsListTypes

getImplementsListTypes

getSuperClass

getInterfaces

getSupers

getSuperTypes

getFields

getMethods

getConstructors

getInnerClasses

getInitializers

getAllFields

getAllMethods

getAllInnerClasses

findFieldByName

findMethodBySignature

findMethodsBySignature

findMethodsByName

findMethodsByName

findMethodsAndTheirSubstitutorsByName

getAllMethodsAndTheirSubstitutors

findInnerClassByName

getLBrace

getRBrace

getNameIdentifier

getScope

isInheritor

isInheritorDeep

getContainingClass

getVisibleSignatures

setName

getClassKind

getSuperClassType

getInterfaceTypes

getRecordComponents

getRecordHeader