Beautified JavaDoc for file index, adjusted parameters names to make them correct...
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / roots / FileIndex.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.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.jps.model.module.JpsModuleSourceRootType;
23
24 import java.util.Set;
25
26 /**
27  * Provides information about files contained in a project or module.
28  *
29  * @see ProjectRootManager#getFileIndex()
30  * @see ModuleRootManager#getFileIndex()
31  */
32 public interface FileIndex {
33   /**
34    * Processes all files and directories under content roots skipping excluded and ignored files and directories.
35    *
36    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
37    */
38   boolean iterateContent(@NotNull ContentIterator processor);
39
40   /**
41    * Processes all files and directories in the content under directory <code>dir</code> (including the directory itself) skipping excluded
42    * and ignored files and directories. Does nothing if <code>dir</code> is not in the content.
43    *
44    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
45    */
46   boolean iterateContentUnderDirectory(@NotNull VirtualFile dir, @NotNull ContentIterator processor);
47
48   /**
49    * Same as {@link #iterateContentUnderDirectory(VirtualFile, ContentIterator)} but allows to pass additional <code>customFilter</code> to
50    * the iterator, in case you need to skip some file system branches using your own logic.
51    */
52   boolean iterateContentUnderDirectory(@NotNull VirtualFile dir,
53                                        @NotNull ContentIterator processor,
54                                        @NotNull VirtualFileFilter customFilter);
55
56   /**
57    * Returns {@code true} if {@code fileOrDir} is a file or directory under a content root of this project or module and not excluded or
58    * ignored.
59    */
60   boolean isInContent(@NotNull VirtualFile fileOrDir);
61
62   /**
63    * Returns {@code true} if {@code file} is a file located under a sources, tests or resources root and not excluded or ignored.
64    * <p/>
65    * Note that sometimes a file can belong to the content and be a source file but not belong to sources of the content.
66    * This happens if sources of some library are located under the content (so they belong to the project content but not as sources).
67    */
68   boolean isContentSourceFile(@NotNull VirtualFile file);
69
70   /**
71    * Returns {@code true} if {@code fileOrDir} is a file or directory located under a sources, tests or resources root and not excluded or ignored.
72    */
73   boolean isInSourceContent(@NotNull VirtualFile fileOrDir);
74
75   /**
76    * Returns true if {@code fileOrDir} is a file or directory located under a test sources or resources root and not excluded or ignored.
77    * <p>
78    * Use this method when you really need to check whether the file is under test roots according to project configuration.
79    * <p>
80    * If you want to determine whether file should be considered as test (e.g. for implementing SearchScope)
81    * you'd better use {@link TestSourcesFilter#isTestSources(VirtualFile, Project)} instead
82    * which includes {@link ProjectFileIndex#isInTestSourceContent(VirtualFile)} invocation.
83    *
84    * @see TestSourcesFilter#isTestSources(VirtualFile, Project)
85    */
86   boolean isInTestSourceContent(@NotNull VirtualFile fileOrDir);
87
88   /**
89    * 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
90    */
91   boolean isUnderSourceRootOfType(@NotNull VirtualFile fileOrDir, @NotNull Set<? extends JpsModuleSourceRootType<?>> rootTypes);
92 }