remove StdFileTypes.JAVA dependency from FileIndex interface
[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
21 /**
22  * Provides information about files contained in a project or module.
23  *
24  * @see ProjectRootManager#getFileIndex()
25  * @see ModuleRootManager#getFileIndex()
26  */
27 public interface FileIndex {
28   /**
29    * Iterates all files and directories in the content.
30    *
31    * @param iterator the iterator receiving the files.
32    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
33    */
34   boolean iterateContent(@NotNull ContentIterator iterator);
35
36   /**
37    * Iterates all files and directories in the content under directory <code>dir</code> (including the directory itself).
38    * Does not iterate anything if <code>dir</code> is not in the content.
39    *
40    * @param dir      the directory the contents of which is iterated.
41    * @param iterator the iterator receiving the files.
42    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
43    */
44   boolean iterateContentUnderDirectory(@NotNull VirtualFile dir, @NotNull ContentIterator iterator);
45
46   /**
47    * Returns true if <code>fileOrDir</code> is a file or directory under a content root of this
48    * project or module.
49    *
50    * @param fileOrDir the file or directory to check.
51    * @return true if the file or directory belongs to a content root, false otherwise.
52    */
53   boolean isInContent(@NotNull VirtualFile fileOrDir);
54
55   /**
56    * Returns true if <code>file</code> is a source file which belongs to sources of the content.
57    * Note that sometimes a file can belong to the content and be a source file but not belong to sources of the content.
58    * This happens if sources of some library are located under the content (so they belong to the project content but not as sources).
59    *
60    * @param file the file to check.
61    * @return true if the file is a source file in the content sources, false otherwise.
62    */
63   boolean isContentSourceFile(@NotNull VirtualFile file);
64
65   /**
66    * Returns true if <code>fileOrDir</code> is a file or directory from the content source.
67    * (Returns true for both source and test source).
68    *
69    * @param fileOrDir the file or directory to check.
70    * @return true if the file or directory belongs to a source or test source root, false otherwise.
71    */
72   boolean isInSourceContent(@NotNull VirtualFile fileOrDir);
73
74   /**
75    * Returns true if <code>fileOrDir</code> is a file or directory from the test content source
76    *
77    * @param fileOrDir the file or directory to check.
78    * @return true if the file or directory belongs to a test source root, false otherwise.
79    */
80   boolean isInTestSourceContent(@NotNull VirtualFile fileOrDir);
81 }