lang-api/src/com/intellij/psi/PsiNamedElement.java

   1 /*
   2  * Copyright 2000-2007 JetBrains s.r.o.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package com.intellij.psi;
  17
  18 import com.intellij.util.IncorrectOperationException;
  19 import org.jetbrains.annotations.NonNls;
  20 import org.jetbrains.annotations.NotNull;
  21 import org.jetbrains.annotations.Nullable;
  22
  23 /**
  24  * A PSI element which has a name and can be renamed (for example, a class or a method).
  25  */
  26 public interface PsiNamedElement extends PsiElement{
  27   /**
  28    * The empty array of PSI named elements which can be reused to avoid unnecessary allocations.
  29    */
  30   PsiNamedElement[] EMPTY_ARRAY = new PsiNamedElement[0];
  31
  32   /**
  33    * Returns the name of the element.
  34    *
  35    * @return the element name.
  36    */
  37   @Nullable @NonNls String getName();
  38
  39   /**
  40    * Renames the element.
  41    *
  42    * @param name the new element name.
  43    * @return the element corresponding to this element after the rename (either <code>this</code>
  44    * or a different element if the rename caused the element to be replaced).
  45    * @throws IncorrectOperationException if the modification is not supported or not possible for some reason.
  46    */
  47   PsiElement setName(@NonNls @NotNull String name) throws IncorrectOperationException;
  48 }