replaced <code></code> with more concise {@code}
[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  *
30  * @see ProjectRootManager#getFileIndex()
31  * @see ModuleRootManager#getFileIndex()
32  */
33 public interface FileIndex {
34   /**
35    * Processes all files and directories under content roots skipping excluded and ignored files and directories.
36    *
37    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
38    */
39   boolean iterateContent(@NotNull ContentIterator processor);
40
41   /**
42    * Same as {@link #iterateContent(ContentIterator)} but allows to pass {@code filter} to
43    * provide filtering in condition for directories.
44    * <p>
45    * If {@code filter} returns false on a directory, the directory won't be processed, but iteration will go on.
46    * <p>
47    * {@code null} filter means that all directories should be processed.
48    *
49    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
50    */
51   boolean iterateContent(@NotNull ContentIterator processor, @Nullable VirtualFileFilter filter);
52
53   /**
54    * Processes all files and directories in the content under directory {@code dir} (including the directory itself) skipping excluded
55    * and ignored files and directories. Does nothing if {@code dir} is not in the content.
56    *
57    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
58    */
59   boolean iterateContentUnderDirectory(@NotNull VirtualFile dir, @NotNull ContentIterator processor);
60
61   /**
62    * Same as {@link #iterateContentUnderDirectory(VirtualFile, ContentIterator)} but allows to pass additional {@code customFilter} to
63    * the iterator, in case you need to skip some file system branches using your own logic. If {@code customFilter} returns false on
64    * a directory, it won't be processed, but iteration will go on.
65    * <p>
66    * {@code null} filter means that all directories should be processed.
67    */
68   boolean iterateContentUnderDirectory(@NotNull VirtualFile dir,
69                                        @NotNull ContentIterator processor,
70                                        @Nullable VirtualFileFilter customFilter);
71
72   /**
73    * Returns {@code true} if {@code fileOrDir} is a file or directory under a content root of this project or module and not excluded or
74    * ignored.
75    */
76   boolean isInContent(@NotNull VirtualFile fileOrDir);
77
78   /**
79    * Returns {@code true} if {@code file} is a file located under a sources, tests or resources root and not excluded or ignored.
80    * <p/>
81    * Note that sometimes a file can belong to the content and be a source file but not belong to sources of the content.
82    * This happens if sources of some library are located under the content (so they belong to the project content but not as sources).
83    */
84   boolean isContentSourceFile(@NotNull VirtualFile file);
85
86   /**
87    * Returns {@code true} if {@code fileOrDir} is a file or directory located under a sources, tests or resources root and not excluded or ignored.
88    */
89   boolean isInSourceContent(@NotNull VirtualFile fileOrDir);
90
91   /**
92    * Returns true if {@code fileOrDir} is a file or directory located under a test sources or resources root and not excluded or ignored.
93    * <p>
94    * Use this method when you really need to check whether the file is under test roots according to project configuration.
95    * <p>
96    * If you want to determine whether file should be considered as test (e.g. for implementing SearchScope)
97    * you'd better use {@link TestSourcesFilter#isTestSources(VirtualFile, Project)} instead
98    * which includes {@link ProjectFileIndex#isInTestSourceContent(VirtualFile)} invocation.
99    *
100    * @see TestSourcesFilter#isTestSources(VirtualFile, Project)
101    */
102   boolean isInTestSourceContent(@NotNull VirtualFile fileOrDir);
103
104   /**
105    * 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
106    */
107   boolean isUnderSourceRootOfType(@NotNull VirtualFile fileOrDir, @NotNull Set<? extends JpsModuleSourceRootType<?>> rootTypes);
108 }