java/openapi/src/com/intellij/psi/PsiImportList.java

   1 /*
   2  * Copyright 2000-2009 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.ArrayFactory;
  19 import org.jetbrains.annotations.NonNls;
  20 import org.jetbrains.annotations.NotNull;
  21 import org.jetbrains.annotations.Nullable;
  22
  23 /**
  24  * Represents the list of import statements contained in a Java or JSP file.
  25  *
  26  * @see PsiJavaFile#getImportList()
  27  */
  28 public interface PsiImportList extends PsiElement {
  29   PsiImportList[] EMPTY_ARRAY = new PsiImportList[0];
  30   ArrayFactory<PsiImportList> ARRAY_FACTORY = new ArrayFactory<PsiImportList>() {
  31     public PsiImportList[] create(int count) {
  32       return count == 0 ? EMPTY_ARRAY : new PsiImportList[count];
  33     }
  34   };
  35
  36   /**
  37    * Returns the non-static import statements contained in the list.
  38    *
  39    * @return the array of non-static import statements.
  40    */
  41   @NotNull PsiImportStatement[] getImportStatements();
  42
  43   /**
  44    * Returns the static import statements contained in the list.
  45    *
  46    * @return the array of static import statements.
  47    */
  48   @NotNull PsiImportStaticStatement[] getImportStaticStatements();
  49
  50   /**
  51    * Returns all import statements contained in the list.
  52    *
  53    * @return the array of import statements.
  54    */
  55   @NotNull PsiImportStatementBase[] getAllImportStatements();
  56
  57   /**
  58    * Searches the list for a single-class import statement importing the specified class.
  59    *
  60    * @param qName the full-qualified name of the imported class.
  61    * @return the import statement, or null if one was not found.
  62    */
  63   @Nullable
  64   PsiImportStatement findSingleClassImportStatement(String qName);
  65
  66   /**
  67    * Searches the list for an on-demand import statement importing the specified class.
  68    *
  69    * @param packageName the name of the imported package.
  70    * @return the import statement, or null if one was not found.
  71    */
  72   @Nullable
  73   PsiImportStatement findOnDemandImportStatement(@NonNls String packageName);
  74
  75   /**
  76    * Searches the list for a single import or import static statement importing the specified
  77    * identifier.
  78    *
  79    * @param name the name of the imported class or method.
  80    * @return the import statement, or null if one was not found.
  81    */
  82   @Nullable
  83   PsiImportStatementBase findSingleImportStatement(String name);
  84
  85   /**
  86    * Checks if replacing this import list with the specified import list will cause no
  87    * modifications to the file.
  88    *
  89    * @param otherList the list to check possibility to replace with.
  90    * @return true if replacing will not cause modifications; false otherwise.
  91    */
  92   boolean isReplaceEquivalent(PsiImportList otherList);
  93 }