Implemented iterateContentUnderDirectory method with additional custom VirtualFile...
[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    * Iterates all files and directories under content roots skipping excluded and ignored files and directories.
35    *
36    * @param iterator the iterator receiving the files.
37    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
38    */
39   boolean iterateContent(@NotNull ContentIterator iterator);
40
41   /**
42    * Iterates all files and directories in the content under directory <code>dir</code> (including the directory itself) skipping excluded
43    * and ignored files and directories. Does not iterate anything if <code>dir</code> is not in the content.
44    *
45    * @param dir      the directory the contents of which is iterated.
46    * @param iterator the iterator receiving the files.
47    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
48    */
49   boolean iterateContentUnderDirectory(@NotNull VirtualFile dir, @NotNull ContentIterator iterator);
50
51   /**
52    * Same as {@link #iterateContentUnderDirectory(VirtualFile, ContentIterator)} but allows to pass additional custom filter to the processor
53    *
54    * @param dir          the directory the contents of which is iterated.
55    * @param iterator     the iterator receiving the files.
56    * @param customFilter custom filter for files and directories
57    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
58    */
59   boolean iterateContentUnderDirectory(@NotNull VirtualFile dir,
60                                        @NotNull ContentIterator iterator,
61                                        @NotNull VirtualFileFilter customFilter);
62
63   /**
64    * Returns {@code true} if {@code fileOrDir} is a file or directory under a content root of this project or module and not excluded or
65    * ignored.
66    */
67   boolean isInContent(@NotNull VirtualFile fileOrDir);
68
69   /**
70    * Returns {@code true} if {@code fileOrDir} is a file located under a sources, tests or resources root and not excluded or ignored.
71    * <p/>
72    * Note that sometimes a file can belong to the content and be a source file but not belong to sources of the content.
73    * This happens if sources of some library are located under the content (so they belong to the project content but not as sources).
74    *
75    * @param file the file to check.
76    * @return true if the file is a source file in the content sources, false otherwise.
77    */
78   boolean isContentSourceFile(@NotNull VirtualFile file);
79
80   /**
81    * Returns {@code true} if {@code fileOrDir} is a file or directory located under a sources, tests or resources root and not excluded or ignored.
82    */
83   boolean isInSourceContent(@NotNull VirtualFile fileOrDir);
84
85   /**
86    * Returns true if {@code fileOrDir} is a file or directory located under a test sources or resources root and not excluded or ignored.
87    * <p>
88    * Use this method when you really need to check whether the file is under test roots according to project configuration.
89    * <p>
90    * If you want to determine whether file should be considered as test (e.g. for implementing SearchScope)
91    * you'd better use {@link TestSourcesFilter#isTestSources(VirtualFile, Project)} instead
92    * which includes {@link ProjectFileIndex#isInTestSourceContent(VirtualFile)} invocation.
93    *
94    * @param fileOrDir the file or directory to check.
95    * @return true if the file or directory belongs to a test source root, false otherwise.
96    * @see TestSourcesFilter#isTestSources(VirtualFile, Project)
97    */
98   boolean isInTestSourceContent(@NotNull VirtualFile fileOrDir);
99
100   /**
101    * 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
102    */
103   boolean isUnderSourceRootOfType(@NotNull VirtualFile fileOrDir, @NotNull Set<? extends JpsModuleSourceRootType<?>> rootTypes);
104 }