f815fe79cccfd07532d6ce195828c57d992e9d94
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / roots / ModuleRootManager.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.module.Module;
19 import org.jetbrains.annotations.NotNull;
20
21 /**
22  * Interface for getting information about the contents and dependencies of a module.
23  *
24  * @author dsl
25  * @see CompilerModuleExtension
26  */
27 public abstract class ModuleRootManager implements ModuleRootModel, ProjectModelElement {
28   /**
29    * Returns the module root manager instance for the specified module.
30    *
31    * @param module the module for which the root manager is requested.
32    * @return the root manager instance.
33    */
34   public static ModuleRootManager getInstance(@NotNull Module module) {
35     return module.getComponent(ModuleRootManager.class);
36   }
37
38   /**
39    * Returns the file index for the current module.
40    *
41    * @return the file index instance.
42    */
43   @NotNull
44   public abstract ModuleFileIndex getFileIndex();
45
46   /**
47    * Returns the interface for modifying the set of roots for this module. Must be called in a read action.
48    * !!!!! WARNING !!!!!: This model MUST be either committed {@link ModifiableRootModel#commit()} or disposed {@link ModifiableRootModel#dispose()}
49    *
50    * @return the modifiable root model.
51    */
52   @NotNull
53   public abstract ModifiableRootModel getModifiableModel();
54
55   /**
56    * Returns the list of modules on which the current module directly depends. The method does not traverse
57    * the entire dependency structure - dependencies of dependency modules are not included in the returned list.
58    *
59    * @return the list of module direct dependencies.
60    */
61   @NotNull
62   public abstract Module[] getDependencies();
63
64   /**
65    * Returns the list of modules on which the current module directly depends. The method does not traverse
66    * the entire dependency structure - dependencies of dependency modules are not included in the returned list.
67    *
68    * @param includeTests whether test-only dependencies should be included
69    * @return the list of module direct dependencies.
70    */
71   @NotNull
72   public abstract Module[] getDependencies(boolean includeTests);
73
74   /**
75    * Checks if the current module directly depends on the specified module.
76    *
77    * @param module the module to check.
78    * @return true if {@code module} is contained in the list of dependencies for the current module, false otherwise.
79    */
80   public abstract boolean isDependsOn(@NotNull Module module);
81 }