i18n: templates (fix more clients) (IDEA-249136)
[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.ApiStatus;
20 import org.jetbrains.annotations.NotNull;
21 import org.jetbrains.annotations.Nullable;
22
23 import java.util.List;
24
25 /**
26  * Provides information about files contained in a module. Should be used from a read action.
27  *
28  * @see ModuleRootManager#getFileIndex()
29  *
30  * @author dsl
31  */
32 @ApiStatus.NonExtendable
33 public interface ModuleFileIndex extends FileIndex {
34   /**
35    * Returns the order entry to which the specified file or directory
36    * belongs.
37    *
38    * @param fileOrDir the file or directory to check.
39    * @return the order entry to which the file or directory belongs, or null if
40    * it does not belong to any order entry.
41    */
42   @Nullable
43   OrderEntry getOrderEntryForFile(@NotNull VirtualFile fileOrDir);
44
45   /**
46    * Returns the list of all order entries to which the specified file or directory
47    * belongs.
48    *
49    * @param fileOrDir the file or directory to check.
50    * @return the list of order entries to which the file or directory belongs.
51    */
52   @NotNull List<OrderEntry> getOrderEntriesForFile(@NotNull VirtualFile fileOrDir);
53 }