lang-api/src/com/intellij/psi/SmartPsiElementPointer.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.openapi.project.Project;
  19 import org.jetbrains.annotations.NotNull;
  20 import org.jetbrains.annotations.Nullable;
  21
  22 /**
  23  * A pointer to a PSI element which can survive PSI reparse.
  24  *
  25  * @see com.intellij.psi.SmartPointerManager#createSmartPsiElementPointer(PsiElement)
  26  * @see com.intellij.psi.SmartPointerManager#createLazyPointer(PsiElement)
  27  */
  28 public interface SmartPsiElementPointer<E extends PsiElement> {
  29   /**
  30    * Returns the PSI element corresponding to the one from which the smart pointer was created in the
  31    * current state of the PSI file.
  32    *
  33    * @return the PSI element, or null if the PSI reparse has completely invalidated the pointer (for example,
  34    * the element referenced by the pointer has been deleted).
  35    */
  36   @Nullable
  37   E getElement();
  38
  39   @Nullable
  40   PsiFile getContainingFile();
  41
  42   @NotNull
  43   Project getProject();
  44 }