FileIndex.*source* javadoc should say that it accounts for both production and tests
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / roots / ProjectFileIndex.java
index 8ada83981017aff61ad0090ab56777d77f182514..d47f640926d52234d75e85cab8b7bfcf9debc897 100644 (file)
@@ -49,6 +49,16 @@ public interface ProjectFileIndex extends FileIndex {
   Module getModuleForFile(@NotNull VirtualFile file);
 
   /**
+   * Returns module to which the specified file belongs.
+   *
+   * @param file the file for which the module is requested.
+   * @param honorExclusion if {@code false} the containing module will be returned even if the file is located under a folder marked as excluded
+   * @return the module instance or null if the file does not belong to content of any module.
+   */
+  @Nullable
+  Module getModuleForFile(@NotNull VirtualFile file, boolean honorExclusion);
+
+  /**
    * Returns the order entries which contain the specified file (either in CLASSES or SOURCES).
    *
    * @param file the file for which the order entries are requested.
@@ -88,6 +98,16 @@ public interface ProjectFileIndex extends FileIndex {
   VirtualFile getContentRootForFile(@NotNull VirtualFile file);
 
   /**
+   * Returns the module content root to which the specified file or directory belongs.
+   *
+   * @param file the file or directory for which the information is requested.
+   * @param honorExclusion if {@code false} the containing content root will be returned even if the file is located under a folder marked as excluded
+   * @return the file for the content root, or null if the file does not belong to this project.
+   */
+  @Nullable
+  VirtualFile getContentRootForFile(@NotNull VirtualFile file, final boolean honorExclusion);
+
+  /**
    * Returns the name of the package corresponding to the specified directory.
    *
    * @param dir the directory for which the package name is requested.
@@ -105,7 +125,7 @@ public interface ProjectFileIndex extends FileIndex {
   boolean isLibraryClassFile(@NotNull VirtualFile file);
 
   /**
-   * Returns true if <code>fileOrDir</code> is a file or directory from the content source or library sources.
+   * Returns true if <code>fileOrDir</code> is a file or directory from the content production/test source or library source.
    *
    * @param fileOrDir the file or directory to check.
    * @return true if the file or directory belongs to project or library sources, false otherwise.
@@ -129,11 +149,28 @@ public interface ProjectFileIndex extends FileIndex {
   boolean isInLibrarySource(@NotNull VirtualFile fileOrDir);
 
   /**
-   * Checks if the specified file or directory is ignored (either excluded by exclude roots
-   * or ignored by {@link com.intellij.openapi.fileTypes.FileTypeManager#isFileIgnored(String)}).
+   * @deprecated name of this method may be confusing. If you want to check if the file is excluded or ignored use {@link #isExcluded(com.intellij.openapi.vfs.VirtualFile)}.
+   * If you want to check if the file is ignored use {@link com.intellij.openapi.fileTypes.FileTypeRegistry#isFileIgnored(com.intellij.openapi.vfs.VirtualFile)}.
+   * If you want to check if the file or one of its parents is ignored use {@link #isUnderIgnored(com.intellij.openapi.vfs.VirtualFile)}.
+   */
+  @Deprecated
+  boolean isIgnored(@NotNull VirtualFile file);
+
+  /**
+   * Checks if the specified file or directory is located under project roots but the file itself or one of its parent directories is
+   * either excluded from the project or ignored by {@link com.intellij.openapi.fileTypes.FileTypeRegistry#isFileIgnored(com.intellij.openapi.vfs.VirtualFile)}).
+   *
+   * @param file the file to check.
+   * @return true if <code>file</code> is excluded or ignored, false otherwise.
+   */
+  boolean isExcluded(@NotNull VirtualFile file);
+
+  /**
+   * Checks if the specified file or directory is located under project roots but the file itself or one of its parent directories is ignored
+   * by {@link com.intellij.openapi.fileTypes.FileTypeRegistry#isFileIgnored(com.intellij.openapi.vfs.VirtualFile)}).
    *
    * @param file the file to check.
    * @return true if <code>file</code> is ignored, false otherwise.
    */
-  boolean isIgnored(@NotNull VirtualFile file);
+  boolean isUnderIgnored(@NotNull VirtualFile file);
 }