unloaded modules: javadocs added
[idea/community.git] / platform / core-api / src / com / intellij / openapi / module / UnloadedModuleDescription.java
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 import org.jetbrains.annotations.NotNull;
21
22 import java.util.List;
23
24 /**
25  * Represents a module which is unloaded from the project. Such modules aren't shown in UI (except for a special 'Load/Unload Modules' dialog),
26  * all of their contents is excluded from the project so it isn't indexed or compiled.
27  *
28  * @author nik
29  */
30 @ApiStatus.Experimental
31 public interface UnloadedModuleDescription extends ModuleDescription {
32   @NotNull
33   List<VirtualFilePointer> getContentRoots();
34
35   @NotNull
36   List<String> getGroupPath();
37 }