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