assert that directory index must be accessed (created) in a read action
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / roots / ModuleFileIndex.java
1 /*
2  * Copyright 2000-2014 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 import org.jetbrains.annotations.Nullable;
21
22 import java.util.List;
23
24 /**
25  * Provides information about files contained in a module. Should be used from a read action.
26  *
27  * @see ModuleRootManager#getFileIndex()
28  *
29  * @author dsl
30  */
31 public interface ModuleFileIndex extends FileIndex {
32   /**
33    * Returns the order entry to which the specified file or directory
34    * belongs.
35    *
36    * @param fileOrDir the file or directory to check.
37    * @return the order entry to which the file or directory belongs, or null if
38    * it does not belong to any order entry.
39    */
40   @Nullable
41   OrderEntry getOrderEntryForFile(@NotNull VirtualFile fileOrDir);
42
43   /**
44    * Returns the list of all order entries to which the specified file or directory
45    * belongs.
46    *
47    * @param fileOrDir the file or directory to check.
48    * @return the list of order entries to which the file or directory belongs.
49    */
50   @NotNull List<OrderEntry> getOrderEntriesForFile(@NotNull VirtualFile fileOrDir);
51 }