javadoc for ProjectFileIndex: clarifications added, some useless tautological comment...
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / roots / ProjectFileIndex.java
1 /*
2  * Copyright 2000-2016 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.components.ServiceManager;
19 import com.intellij.openapi.fileTypes.FileTypeRegistry;
20 import com.intellij.openapi.module.Module;
21 import com.intellij.openapi.project.Project;
22 import com.intellij.openapi.vfs.VirtualFile;
23 import org.jetbrains.annotations.NotNull;
24 import org.jetbrains.annotations.Nullable;
25
26 import java.util.List;
27
28 /**
29  * Provides information about files contained in a project.
30  *
31  * @see ProjectRootManager#getFileIndex()
32  */
33 public interface ProjectFileIndex extends FileIndex {
34   class SERVICE {
35     private SERVICE() { }
36
37     public static ProjectFileIndex getInstance(Project project) {
38       return ServiceManager.getService(project, ProjectFileIndex.class);
39     }
40   }
41
42   /**
43    * Returns module to which content the specified file belongs or null if the file does not belong to content of any module.
44    */
45   @Nullable
46   Module getModuleForFile(@NotNull VirtualFile file);
47
48   /**
49    * Returns module to which content the specified file belongs or null if the file does not belong to content of any module.
50    *
51    * @param honorExclusion if {@code false} the containing module will be returned even if the file is located under a folder marked as excluded
52    */
53   @Nullable
54   Module getModuleForFile(@NotNull VirtualFile file, boolean honorExclusion);
55
56   /**
57    * Returns the order entries which contain the specified file (either in CLASSES or SOURCES).
58    */
59   @NotNull
60   List<OrderEntry> getOrderEntriesForFile(@NotNull VirtualFile file);
61
62   /**
63    * Returns a classpath entry to which the specified file or directory belongs.
64    *
65    * @return the file for the classpath entry, or null if the file is not a compiled
66    *         class file or directory belonging to a library.
67    */
68   @Nullable
69   VirtualFile getClassRootForFile(@NotNull VirtualFile file);
70
71   /**
72    * Returns the module source root or library source root to which the specified file or directory belongs.
73    *
74    * @return the file for the source root, or null if the file is not located under any of the source roots for the module.
75    */
76   @Nullable
77   VirtualFile getSourceRootForFile(@NotNull VirtualFile file);
78
79   /**
80    * Returns the module content root to which the specified file or directory belongs or null if the file does not belong to content of any module.
81    */
82   @Nullable
83   VirtualFile getContentRootForFile(@NotNull VirtualFile file);
84
85   /**
86    * Returns the module content root to which the specified file or directory belongs or null if the file does not belong to content of any module.
87    *
88    * @param honorExclusion if {@code false} the containing content root will be returned even if the file is located under a folder marked as excluded
89    */
90   @Nullable
91   VirtualFile getContentRootForFile(@NotNull VirtualFile file, final boolean honorExclusion);
92
93   /**
94    * Returns the name of the package corresponding to the specified directory.
95    *
96    * @return the package name, or null if the directory does not correspond to any package.
97    */
98   @Nullable
99   String getPackageNameByDirectory(@NotNull VirtualFile dir); //Q: move to FileIndex?
100
101   /**
102    * Returns true if <code>file</code> is a file which belongs to the classes (not sources) of some library which is included into dependencies
103    * of some module.
104    */
105   boolean isLibraryClassFile(@NotNull VirtualFile file);
106
107   /**
108    * Returns true if <code>fileOrDir</code> is a file or directory from production/test sources of some module or sources of some library which is included into dependencies
109    * of some module.
110    */
111   boolean isInSource(@NotNull VirtualFile fileOrDir);
112
113   /**
114    * Returns true if <code>fileOrDir</code> belongs to classes of some library which is included into dependencies of some module.
115    */
116   boolean isInLibraryClasses(@NotNull VirtualFile fileOrDir);
117
118   /**
119    * @return true if the file belongs to the classes or sources of a library added to dependencies of the project,
120    *         false otherwise
121    */
122   boolean isInLibrary(@NotNull VirtualFile fileOrDir);
123
124   /**
125    * Returns true if <code>fileOrDir</code> is a file or directory from sources of some library which is included into dependencies
126    * of some module.
127    */
128   boolean isInLibrarySource(@NotNull VirtualFile fileOrDir);
129
130   /**
131    * @deprecated name of this method may be confusing. If you want to check if the file is excluded or ignored use {@link #isExcluded(VirtualFile)}.
132    * If you want to check if the file is ignored use {@link FileTypeRegistry#isFileIgnored(VirtualFile)}.
133    * If you want to check if the file or one of its parents is ignored use {@link #isUnderIgnored(VirtualFile)}.
134    */
135   @Deprecated
136   boolean isIgnored(@NotNull VirtualFile file);
137
138   /**
139    * Checks if the specified file or directory is located under project roots but the file itself or one of its parent directories is
140    * either excluded from the project or ignored by {@link FileTypeRegistry#isFileIgnored(VirtualFile)}).
141    *
142    * @return true if <code>file</code> is excluded or ignored, false otherwise.
143    */
144   boolean isExcluded(@NotNull VirtualFile file);
145
146   /**
147    * Checks if the specified file or directory is located under project roots but the file itself or one of its parent directories is ignored
148    * by {@link FileTypeRegistry#isFileIgnored(VirtualFile)}).
149    *
150    * @return true if <code>file</code> is ignored, false otherwise.
151    */
152   boolean isUnderIgnored(@NotNull VirtualFile file);
153 }