d2da9b3657206ec45d3378f06fd8591a67a625bb
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / module / ModuleDescription.kt
1 /*
2  * Copyright 2000-2017 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.module
17
18 import com.intellij.openapi.vfs.pointers.VirtualFilePointer
19 import org.jetbrains.annotations.ApiStatus
20
21 /**
22  * Represents a description of a module which may be either loaded into the project or unloaded. Use this class only if you need to process
23  * all modules including unloaded, in other cases [Module] should be used instead.
24  * @see [ModuleManager.getUnloadedModuleDescriptions]
25  * @author nik
26  */
27 @ApiStatus.Experimental
28 interface ModuleDescription {
29   val name: String
30
31   /**
32    * Names of the modules on which the current module depend.
33    */
34   val dependencyModuleNames: List<String>
35 }
36
37 @ApiStatus.Experimental
38 interface UnloadedModuleDescription : ModuleDescription {
39   val contentRoots: List<VirtualFilePointer>
40   val groupPath: List<String>
41 }
42
43 @ApiStatus.Experimental
44 interface LoadedModuleDescription : ModuleDescription {
45   val module: Module
46 }