platform/lang-api/src/com/intellij/openapi/roots/ModuleFileIndex.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.openapi.roots;
  17
  18 import com.intellij.openapi.vfs.VirtualFile;
  19 import org.jetbrains.annotations.NotNull;
  20 import org.jetbrains.annotations.Nullable;
  21
  22 import java.util.List;
  23
  24 /**
  25  * Provides information about files contained in a module.
  26  *
  27  * @author dsl
  28  */
  29 public interface ModuleFileIndex extends FileIndex {
  30   /**
  31    * Returns the order entry to which the specified file or directory
  32    * belongs.
  33    *
  34    * @param fileOrDir the file or directory to check.
  35    * @return the order entry to which the file or directory belongs, or null if
  36    * it does not belong to any order entry.
  37    */
  38   @Nullable
  39   OrderEntry getOrderEntryForFile(VirtualFile fileOrDir);
  40
  41   /**
  42    * Returns the list of all order entries to which the specified file or directory
  43    * belongs.
  44    *
  45    * @param fileOrDir the file or directory to check.
  46    * @return the list of order entries to which the file or directory belongs.
  47    */
  48   @NotNull List<OrderEntry> getOrderEntriesForFile(VirtualFile fileOrDir);
  49 }