AbstractLightClass (Unofficial IntelliJ Community Edition API docs)

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.AbstractLightClass

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, java.lang.Cloneable

Direct Known Subclasses:

LightClass
```
public abstract class AbstractLightClass
extends LightElement
implements PsiClass
```

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
Modifier	Constructor and Description
`protected`	`AbstractLightClass(PsiManager manager)`
`protected`	`AbstractLightClass(PsiManager manager, Language language)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(PsiElementVisitor visitor)` Passes the element to the specified visitor.
`abstract PsiElement`	`copy()` Creates a copy of the file containing the PSI element and returns the corresponding element in the created copy.
`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.
`PsiClass`	`getContainingClass()` For an inner class, returns its containing class.
`PsiFile`	`getContainingFile()` Returns the file containing the PSI element.
`PsiElement`	`getContext()` Returns the element which should be used as the parent of this element in a tree up walk during a resolve operation.
`abstract PsiClass`	`getDelegate()`
`PsiDocComment`	`getDocComment()` Returns the JavaDoc comment for the element, or `null` when the element has no JavaDoc comment.
`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.
`PsiElement`	`getLBrace()` Returns the token representing the opening curly brace of the class.
`PsiMethod []`	`getMethods()` Returns the list of methods in the class.
`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.
`PsiElement`	`getNavigationElement()` Returns the PSI element which should be used as a navigation target when navigation to this PSI element is requested.
`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.
`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.
`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.lang.String`	`getText()` Returns the text of the PSI element.
`PsiTypeParameterList`	`getTypeParameterList()` Returns the type parameter list for the element.
`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`	`isEquivalentTo(PsiElement another)` This method shouldn't be called by clients directly, because there are no guarantees of it being symmetric.
`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`	`isValid()` Checks if this PSI element is valid.
`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
add, addAfter, addBefore, checkAdd, checkDelete, delete, findElementAt, getChildren, getLanguage, getManager, getNextSibling, getNode, getParent, getPrevSibling, getStartOffsetInParent, getTextLength, getTextOffset, getTextRange, isPhysical, 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, getFirstChild, getLastChild, getOriginalElement, getPresentation, getProject, getReference, getReferences, getResolveScope, getUseScope, 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, getInterfaceTypes, getRecordComponents, getRecordHeader, getSuperClassType, isRecord

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

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
acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNextSibling, getNode, getOriginalElement, getOwnReferences, getParent, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, getUseScope, isPhysical, 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.pom.PomRenameableTarget
isWritable

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

- Constructor Detail
  - AbstractLightClass
```
protected AbstractLightClass(PsiManager manager,
                             Language language)
```
  - AbstractLightClass
```
protected AbstractLightClass(PsiManager manager)
```
- Method Detail
  - getDelegate
```
public abstract PsiClass getDelegate()
```
  - copy
```
public abstract PsiElement copy()
```
    Description copied from interface: PsiElement
    
    Creates a copy of the file containing the PSI element and returns the corresponding element in the created copy. Resolve operations performed on elements in the copy of the file will resolve to elements in the copy, not in the original file.
    
    Specified by:
    
    copy in interface PsiElement
    
    Overrides:
    
    copy in class LightElement
    
    Returns:
    
    the element in the file copy corresponding to this element.
  - 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()
  - getModifierList
```
public 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
  - 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
  - getTypeParameterList
```
public PsiTypeParameterList getTypeParameterList()
```
    Description copied from interface: PsiTypeParameterListOwner
    
    Returns the type parameter list for the element.
    
    Specified by:
    
    getTypeParameterList in interface PsiTypeParameterListOwner
    
    Returns:
    
    the type parameter list, or null if the element has no type parameters.
  - 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()
  - 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()
  - 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.
  - getExtendsList
```
public PsiReferenceList getExtendsList()
```
    Description copied from interface: PsiClass
    
    Returns the list of classes that this class or interface extends.
    
    Specified by:
    
    getExtendsList in interface PsiClass
    
    Returns:
    
    the extends list, or null for anonymous classes.
  - getImplementsList
```
public PsiReferenceList getImplementsList()
```
    Description copied from interface: PsiClass
    
    Returns the list of interfaces that this class implements.
    
    Specified by:
    
    getImplementsList in interface PsiClass
    
    Returns:
    
    the implements list, or null for anonymous classes
  - 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.
  - getNavigationElement
```
public PsiElement getNavigationElement()
```
    Description copied from interface: PsiElement
    
    Returns the PSI element which should be used as a navigation target when navigation to this PSI element is requested. The method can either return this or substitute a different element if this element does not have an associated file and offset. (For example, if the source code of a library is attached to a project, the navigation element for a compiled library class is its source class.)
    
    Specified by:
    
    getNavigationElement in interface PsiElement
    
    Specified by:
    
    getNavigationElement in interface PsiTarget
    
    Overrides:
    
    getNavigationElement in class LightElement
    
    Returns:
    
    the navigation target element.
  - 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.
  - getFields
```
public PsiField [] getFields()
```
    Description copied from interface: PsiClass
    
    Returns the list of fields in the class.
    
    Specified by:
    
    getFields in interface JvmClass
    
    Specified by:
    
    getFields in interface PsiClass
    
    Returns:
    
    the list of fields.
    
    See Also:
    
    Class.getDeclaredFields()
  - getMethods
```
public PsiMethod [] getMethods()
```
    Description copied from interface: PsiClass
    
    Returns the list of methods in the class.
    
    Specified by:
    
    getMethods in interface JvmClass
    
    Specified by:
    
    getMethods in interface PsiClass
    
    Returns:
    
    the list of methods.
    
    See Also:
    
    Class.getDeclaredMethods(), Class.getDeclaredConstructors()
  - 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,
  - getInnerClasses
```
public PsiClass [] getInnerClasses()
```
    Description copied from interface: PsiClass
    
    Returns the list of inner classes for the class.
    
    Specified by:
    
    getInnerClasses in interface JvmClass
    
    Specified by:
    
    getInnerClasses in interface PsiClass
    
    Returns:
    
    the list of inner classes.
    
    See Also:
    
    Class.getDeclaredClasses()
  - getInitializers
```
public PsiClassInitializer [] getInitializers()
```
    Description copied from interface: PsiClass
    
    Returns the list of class initializers for the class.
    
    Specified by:
    
    getInitializers in interface PsiClass
    
    Returns:
    
    the list of class initializers.
  - 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.
  - 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
  - getScope
```
public PsiElement getScope()
```
    Description copied from interface: PsiClass
    
    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).
    
    Specified by:
    
    getScope in interface PsiClass
    
    Returns:
    
    the member in which the class has been declared.
  - 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
  - getContainingClass
```
public PsiClass getContainingClass()
```
    Description copied from interface: PsiClass
    
    For an inner class, returns its containing class.
    
    Specified by:
    
    getContainingClass in interface JvmMember
    
    Specified by:
    
    getContainingClass in interface PsiClass
    
    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
```
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.
  - 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
  - getText
```
public java.lang.String getText()
```
    Description copied from interface: PsiElement
    
    Returns the text of the PSI element.
    Note: This call requires traversing whole subtree, so it can be expensive for composite elements, and should be avoided if possible.
    
    Specified by:
    
    getText in interface PsiElement
    
    Overrides:
    
    getText in class LightElement
    
    Returns:
    
    the element text.
    
    See Also:
    
    PsiElement.textMatches(java.lang.CharSequence), PsiElement.textContains(char)
  - accept
```
public void accept(PsiElementVisitor visitor)
```
    Description copied from interface: PsiElement
    
    Passes the element to the specified visitor.
    
    Specified by:
    
    accept in interface PsiElement
    
    Overrides:
    
    accept in class LightElement
    
    Parameters:
    
    visitor - the visitor to pass the element to.
  - getContainingFile
```
public PsiFile getContainingFile()
```
    Description copied from interface: PsiElement
    
    Returns the file containing the PSI element.
    Note: this method might need to traverse the whole AST up, which can be slow in deep trees, so invoking this method should be avoided if possible.
    
    Specified by:
    
    getContainingFile in interface PsiElement
    
    Overrides:
    
    getContainingFile in class LightElement
    
    Returns:
    
    the file instance, or null if the PSI element is not contained in a file (for example, the element represents a package or directory).
  - 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 PsiElementBase
    
    Returns:
    
    the resolve context element.
  - isValid
```
public boolean isValid()
```
    Description copied from interface: PsiElement
    Checks if this PSI element is valid. Valid elements and their hierarchy members can be accessed for reading and writing. Valid elements can still correspond to underlying documents whose text is different, when those documents have been changed and not yet committed (PsiDocumentManager.commitDocument(com.intellij.openapi.editor.Document)). (In this case an attempt to change PSI will result in an exception). Any access to invalid elements results in PsiInvalidElementAccessException. Once invalid, elements can't become valid again. Elements become invalid in following cases:
    - They have been deleted via PSI operation (PsiElement.delete())
    - They have been deleted as a result of an incremental reparse (document commit)
    - Their containing file has been changed externally, or renamed so that its PSI had to be rebuilt from scratch
    Specified by:
    
    isValid in interface PomTarget
    
    Specified by:
    
    isValid in interface PsiElement
    
    Overrides:
    
    isValid in class LightElement
    
    Returns:
    
    true if the element is valid, false otherwise.
    
    See Also:
    
    PsiUtilCore.ensureValid(PsiElement)
  - isEquivalentTo
```
public boolean isEquivalentTo(PsiElement another)
```
    Description copied from interface: PsiElement
    
    This method shouldn't be called by clients directly, because there are no guarantees of it being symmetric. It's called by PsiManager.areElementsEquivalent(PsiElement, PsiElement) internally, which clients should invoke instead.
    Implementations of this method should return true if the parameter is resolve-equivalent to this, i.e. it represents the same entity from the language perspective. See also PsiManager.areElementsEquivalent(PsiElement, PsiElement) documentation.
    
    Specified by:
    
    isEquivalentTo in interface PsiElement
    
    Overrides:
    
    isEquivalentTo in class PsiElementBase

Class AbstractLightClass

Nested Class Summary

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

Field Summary

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

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

Fields inherited from interface com.intellij.psi.PsiClass

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.intellij.psi.PsiClass

Methods inherited from interface com.intellij.psi.PsiNameIdentifierOwner

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.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.pom.PomRenameableTarget

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

Constructor Detail

AbstractLightClass

AbstractLightClass

Method Detail

getDelegate

copy

getName

getModifierList

hasModifierProperty

getDocComment

isDeprecated

hasTypeParameters

getTypeParameterList

getTypeParameters

getQualifiedName

isInterface

isAnnotationType

isEnum

getExtendsList

getImplementsList

getExtendsListTypes

getImplementsListTypes

getSuperClass

getInterfaces

getNavigationElement

getSupers

getSuperTypes

getFields

getMethods

getConstructors

getInnerClasses

getInitializers

processDeclarations

getAllFields

getAllMethods

getAllInnerClasses

findFieldByName

findMethodBySignature

findMethodsBySignature

findMethodsByName

findMethodsAndTheirSubstitutorsByName

getAllMethodsAndTheirSubstitutors

findInnerClassByName

getLBrace

getRBrace

getNameIdentifier

getScope

isInheritor

isInheritorDeep

getContainingClass

getVisibleSignatures

setName

toString