FileIndex.*source* javadoc should say that it accounts for both production and tests
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / roots / FileIndex.java
1 /*
2  * Copyright 2000-2012 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.jps.model.module.JpsModuleSourceRootType;
21
22 import java.util.Set;
23
24 /**
25  * Provides information about files contained in a project or module.
26  *
27  * @see ProjectRootManager#getFileIndex()
28  * @see ModuleRootManager#getFileIndex()
29  */
30 public interface FileIndex {
31   /**
32    * Iterates all files and directories in the content.
33    *
34    * @param iterator the iterator receiving the files.
35    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
36    */
37   boolean iterateContent(@NotNull ContentIterator iterator);
38
39   /**
40    * Iterates all files and directories in the content under directory <code>dir</code> (including the directory itself).
41    * Does not iterate anything if <code>dir</code> is not in the content.
42    *
43    * @param dir      the directory the contents of which is iterated.
44    * @param iterator the iterator receiving the files.
45    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
46    */
47   boolean iterateContentUnderDirectory(@NotNull VirtualFile dir, @NotNull ContentIterator iterator);
48
49   /**
50    * Returns true if <code>fileOrDir</code> is a file or directory under a content root of this
51    * project or module.
52    *
53    * @param fileOrDir the file or directory to check.
54    * @return true if the file or directory belongs to a content root, false otherwise.
55    */
56   boolean isInContent(@NotNull VirtualFile fileOrDir);
57
58   /**
59    * Returns true if <code>file</code> is a source file which belongs to sources of the content.
60    * (Returns true for both source and test source).<p/>
61    * Note that sometimes a file can belong to the content and be a source file but not belong to sources of the content.
62    * This happens if sources of some library are located under the content (so they belong to the project content but not as sources).
63    *
64    * @param file the file to check.
65    * @return true if the file is a source file in the content sources, false otherwise.
66    */
67   boolean isContentSourceFile(@NotNull VirtualFile file);
68
69   /**
70    * Returns true if <code>fileOrDir</code> is a file or directory from the content source.
71    * (Returns true for both source and test source).
72    *
73    * @param fileOrDir the file or directory to check.
74    * @return true if the file or directory belongs to a source or test source root, false otherwise.
75    */
76   boolean isInSourceContent(@NotNull VirtualFile fileOrDir);
77
78   /**
79    * Returns true if <code>fileOrDir</code> is a file or directory from the test content source
80    *
81    * @param fileOrDir the file or directory to check.
82    * @return true if the file or directory belongs to a test source root, false otherwise.
83    */
84   boolean isInTestSourceContent(@NotNull VirtualFile fileOrDir);
85
86   /**
87    * Returns true if <code>fileOrDir</code> is a file or directory from the source root which have
88    *
89    * @param fileOrDir the file or directory to check.
90    * @return true if the file or directory belongs to a source root of one of specified types, false otherwise
91    */
92   boolean isUnderSourceRootOfType(@NotNull VirtualFile fileOrDir, @NotNull Set<? extends JpsModuleSourceRootType<?>> rootTypes);
93 }