Package com.intellij.psi

Interface PsiNamedElement

All Superinterfaces:

Iconable, PsiElement, UserDataHolder

All Known Subinterfaces:

BaseJspFile, GrAccessorMethod, GrAnnotationMethod, GrAnnotationTypeDefinition, GrAnonymousClassDefinition, GrClassDefinition, GrDocInlinedTag, GrDocTag, GrEnumConstant, GrEnumConstantInitializer, GrEnumTypeDefinition, GrField, GrGdkMethod, GrImplicitVariable, GrInterfaceDefinition, GrLabeledStatement, GrMethod, GrNamedElement, GroovyFile, GroovyFileBase, GroovyMapProperty, GroovyProperty, GrParameter, GrReflectedMethod, GrTraitTypeDefinition, GrTypeDefinition, GrTypeParameter, GrVariable, Header, HtmlTag, ImplicitVariable, JavaCodeFragment, JsonFile, JspClass, JspDeclaration, JspDirective, JspExpression, JspFile, JspHolderMethod, JspScriptlet, JspTag, JspXmlRootTag, JspXmlTagBase, ManifestFile, PackagePrefixFileSystemItem, Property, PsiAnnotationMethod, PsiAnonymousClass, PsiBinaryFile, PsiCheckedRenameElement, PsiClass, PsiClassOwner, PsiClassOwnerEx, PsiCodeFragment, PsiCompiledFile, PsiDirectory, PsiDirectoryContainer, PsiDocTag, PsiEnumConstant, PsiEnumConstantInitializer, PsiExpressionCodeFragment, PsiExtensibleClass, PsiField, PsiFile, PsiFileEx, PsiFileSystemItem, PsiFileWithStubSupport, PsiImportHolder, PsiInlineDocTag, PsiJavaCodeReferenceCodeFragment, PsiJavaFile, PsiJavaModule, PsiJShellFile, PsiJShellHolderMethod, PsiJShellRootClass, PsiLabeledStatement, PsiLargeBinaryFile, PsiLargeFile, PsiLargeTextFile, PsiLocalVariable, PsiMethod, PsiNameIdentifierOwner, PsiPackage, PsiParameter, PsiPatternVariable, PsiPlainTextFile, PsiQualifiedNamedElement, PsiReceiverParameter, PsiRecordComponent, PsiResourceVariable, PsiSyntheticClass, PsiTypeCodeFragment, PsiTypeParameter, PsiVariable, PsiVariableEx, PyClass, PyExpressionCodeFragment, PyFile, PyFunction, PyKeywordArgument, PyNamedParameter, PyTargetExpression, RegExpGroup, RncDecl, RncDefine, RncFile, RncNsDecl, ServerPageFile, XmlAttribute, XmlAttributeDecl, XmlElementDecl, XmlEntityDecl, XmlFile, XmlTag, XPathFunction, XPathVariable, XsltFunction, XsltParameter, XsltTemplate, XsltVariable, YAMLAnchor, YAMLFile, YAMLKeyValue

All Known Implementing Classes:

AbstractLightClass, BeanPropertyElement, BuilderHelperLightPsiClass, BuildoutCfgFile, ClosureSyntheticParameter, ClsClassImpl, ClsEnumConstantImpl, ClsFieldImpl, ClsFileImpl, ClsJavaModuleImpl, ClsMemberImpl, ClsMethodImpl, ClsParameterImpl, ClsTypeParameterImpl, CommandLineFile, CustomMembersGenerator.GdslNamedParameter, DelegatedMethod, DummyHolder, EmptyXmlTag, FakePsiElement, GoToSymbolProvider.BaseNavigationItem, GrAccessorMethodImpl, GrAnnotationMethodImpl, GrAnnotationTypeDefinitionImpl, GrAnonymousClassDefinitionImpl, GrBindingVariable, GrClassDefinitionImpl, GrConstructorImpl, GrDocInlinedTagImpl, GrDocTagImpl, GrDynamicImplicitMethod, GrDynamicImplicitProperty, GrDynamicMethodImpl, GrDynamicPropertyImpl, GrEnumConstantImpl, GrEnumConstantInitializerImpl, GrEnumTypeDefinitionImpl, GrFieldImpl, GrGdkMethodImpl, GrImplicitVariableImpl, GrInterfaceDefinitionImpl, GrLabeledStatementImpl, GrLightField, GrLightMethodBuilder, GrLightParameter, GrLightTypeDefinitionBase, GrLightVariable, GrMethodBaseImpl, GrMethodImpl, GrMethodWrapper, GroovyCodeFragment, GroovyFileBaseImpl, GroovyFileImpl, GroovyScriptClass, GroovyShellCodeFragment, GrParameterImpl, GrPropertyForCompletion, GrReflectedMethodImpl, GrRenamableLightMethodBuilder, GrScriptField, GrTraitField, GrTraitMethod, GrTraitTypeDefinitionImpl, GrTypeDefinitionImpl, GrTypeParameterImpl, GrVariableBaseImpl, GrVariableImpl, HeaderImpl, HtmlFileImpl, HtmlStubBasedTagImpl, HtmlTagImpl, IgnoreFile, ImplicitModeElement, ImplicitVariableImpl, IncludedXmlAttribute, IncludedXmlTag, InferenceVariable, InspectionElement, JavaDummyHolder, JavaFxPropertyElement, JqlFile, JShellFileImpl, JsonFileImpl, LightClass, LightCompactConstructorParameter, LightField, LightFieldBuilder, LightJavaModule, LightMethod, LightMethodBuilder, LightNamedElement, LightParameter, LightParameterWrapper, LightPsiClassBase, LightPsiClassBuilder, LightPsiFileBase, LightPsiFileImpl, LightRecordCanonicalConstructor, LightRecordField, LightRecordMethod, LightTypeParameter, LightTypeParameterBuilder, LightVariableBase, LightVariableBuilder, ManifestFileImpl, MarkdownFile, MigrationClassImpl, MigrationPackageImpl, PomTargetPsiElementImpl, PropertiesFileImpl, PropertyImpl, PsiAnnotationMethodImpl, PsiAnonymousClassImpl, PsiBinaryFileImpl, PsiClassImpl, PsiCodeFragmentImpl, PsiDirectoryImpl, PsiDocTagImpl, PsiEnumConstantImpl, PsiEnumConstantInitializerImpl, PsiExpressionCodeFragmentImpl, PsiFieldImpl, PsiFileBase, PsiFileImpl, PsiInlineDocTagImpl, PsiJavaCodeReferenceCodeFragmentImpl, PsiJavaDirectoryImpl, PsiJavaFileBaseImpl, PsiJavaFileImpl, PsiJavaModuleImpl, PsiJShellHolderMethodImpl, PsiJShellRootClassImpl, PsiLabeledStatementImpl, PsiLargeBinaryFileImpl, PsiLargeTextFileImpl, PsiLocalVariableImpl, PsiMethodImpl, PsiPackageBase, PsiPackageImpl, PsiParameterImpl, PsiPatternVariableImpl, PsiPlainTextFileImpl, PsiReceiverParameterImpl, PsiRecordComponentImpl, PsiResourceVariableImpl, PsiTypeCodeFragmentImpl, PsiTypeParameterImpl, PyBoundFunction, PyClassImpl, PydevConsoleElement, PyDocstringFile, PyExpressionCodeFragment, PyExpressionCodeFragmentImpl, PyFileImpl, PyFunctionImpl, PyFunctionTypeAnnotationFile, PyKeywordArgumentImpl, PyNamedParameterImpl, PyTargetExpressionImpl, RegExpFile, RegExpGroupImpl, RenameableFakePsiElement, RestFile, RncDeclImpl, RncDefineImpl, RncFileImpl, RncNsDeclImpl, SchemaPrefix, ShFile, SPIFile, SyntheticFileSystemItem, TaskPsiElement, TextMateFile, XmlAttributeDeclImpl, XmlAttributeImpl, XmlElementDeclImpl, XmlEntityDeclImpl, XmlFileImpl, XmlStubBasedAttribute, XmlStubBasedAttributeBase, XmlStubBasedTag, XmlStubBasedTagBase, XmlTagImpl, XPath2VariableImpl, XPathFile, XsltFunctionImpl, XsltParameterImpl, XsltTemplateImpl, XsltVariableImpl, YAMLAnchorImpl, YAMLFileImpl, YAMLKeyValueImpl, YouTrackFile

public interface PsiNamedElement
extends PsiElement

A PSI element which has a name and can be renamed (for example, a class or a method).

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 PsiNamedElement[]	EMPTY_ARRAY The empty array of PSI named elements which can be reused to avoid unnecessary allocations.

Fields inherited from interface com.intellij.psi.PsiElement

ARRAY_FACTORY

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

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of the element.
PsiElement	setName(java.lang.String name) Renames the element.

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, processDeclarations, putCopyableUserData, replace, textContains, textMatches, textMatches, textToCharArray, toString

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

getUserData, putUserData

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

getIcon

Field Detail

EMPTY_ARRAY

static final PsiNamedElement[] EMPTY_ARRAY

The empty array of PSI named elements which can be reused to avoid unnecessary allocations.

Method Detail

getName

java.lang.String getName()

Returns the name of the element.

Returns:

the element name.

setName

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

Renames the element.

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.