Merge remote-tracking branch 'origin/master' into amakeev/gradle
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / roots / FileIndex.java
1 /*
2  * Copyright 2000-2017 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.project.Project;
19 import com.intellij.openapi.vfs.VirtualFile;
20 import com.intellij.openapi.vfs.VirtualFileFilter;
21 import org.jetbrains.annotations.NotNull;
22 import org.jetbrains.annotations.Nullable;
23 import org.jetbrains.jps.model.module.JpsModuleSourceRootType;
24
25 import java.util.Set;
26
27 /**
28  * Provides information about files contained in a project or module.
29  * In this interface and its inheritors, methods checking specific file status ("isX", "getX") should be used from a read action.
30  * Iteration methods ("iterateX") may be called outside of a read action (since iteration can take a long time),
31  * but they should be prepared to project model being changed in the middle of the iteration.
32  *
33  * @see ProjectRootManager#getFileIndex()
34  * @see ModuleRootManager#getFileIndex()
35  */
36 public interface FileIndex {
37   /**
38    * Processes all files and directories under content roots skipping excluded and ignored files and directories.
39    *
40    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
41    */
42   boolean iterateContent(@NotNull ContentIterator processor);
43
44   /**
45    * Same as {@link #iterateContent(ContentIterator)} but allows to pass {@code filter} to
46    * provide filtering in condition for directories.
47    * <p>
48    * If {@code filter} returns false on a directory, the directory won't be processed, but iteration will go on.
49    * <p>
50    * {@code null} filter means that all directories should be processed.
51    *
52    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
53    */
54   boolean iterateContent(@NotNull ContentIterator processor, @Nullable VirtualFileFilter filter);
55
56   /**
57    * Processes all files and directories in the content under directory {@code dir} (including the directory itself) skipping excluded
58    * and ignored files and directories. Does nothing if {@code dir} is not in the content.
59    *
60    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
61    */
62   boolean iterateContentUnderDirectory(@NotNull VirtualFile dir, @NotNull ContentIterator processor);
63
64   /**
65    * Same as {@link #iterateContentUnderDirectory(VirtualFile, ContentIterator)} but allows to pass additional {@code customFilter} to
66    * the iterator, in case you need to skip some file system branches using your own logic. If {@code customFilter} returns false on
67    * a directory, it won't be processed, but iteration will go on.
68    * <p>
69    * {@code null} filter means that all directories should be processed.
70    */
71   boolean iterateContentUnderDirectory(@NotNull VirtualFile dir,
72                                        @NotNull ContentIterator processor,
73                                        @Nullable VirtualFileFilter customFilter);
74
75   /**
76    * Returns {@code true} if {@code fileOrDir} is a file or directory under a content root of this project or module and not excluded or
77    * ignored.
78    */
79   boolean isInContent(@NotNull VirtualFile fileOrDir);
80
81   /**
82    * @deprecated name of this method is unclear, use {@link #isInSourceContent(VirtualFile)} instead and add {@code !file.isDirectory()} check
83    * if you want to accept files only.
84    */
85   @Deprecated
86   boolean isContentSourceFile(@NotNull VirtualFile file);
87
88   /**
89    * Returns {@code true} if {@code fileOrDir} is a file or directory located under a sources, tests or resources root and not excluded or ignored.
90    */
91   boolean isInSourceContent(@NotNull VirtualFile fileOrDir);
92
93   /**
94    * Returns true if {@code fileOrDir} is a file or directory located under a test sources or resources root and not excluded or ignored.
95    * <p>
96    * Use this method when you really need to check whether the file is under test roots according to project configuration.
97    * <p>
98    * If you want to determine whether file should be considered as test (e.g. for implementing SearchScope)
99    * you'd better use {@link TestSourcesFilter#isTestSources(VirtualFile, Project)} instead
100    * which includes {@link ProjectFileIndex#isInTestSourceContent(VirtualFile)} invocation.
101    *
102    * @see TestSourcesFilter#isTestSources(VirtualFile, Project)
103    */
104   boolean isInTestSourceContent(@NotNull VirtualFile fileOrDir);
105
106   /**
107    * Returns {@code true} if {@code fileOrDir} is a file or directory located under a source root of type from {@code rootTypes} set and not excluded or ignored
108    */
109   boolean isUnderSourceRootOfType(@NotNull VirtualFile fileOrDir, @NotNull Set<? extends JpsModuleSourceRootType<?>> rootTypes);
110 }