IDEA-150835: Provide an API which tells which production module corresponding to...
[idea/community.git] / platform / projectModel-impl / src / com / intellij / openapi / roots / TestModuleProperties.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 com.intellij.openapi.module.ModuleServiceManager;
20 import org.jetbrains.annotations.NotNull;
21 import org.jetbrains.annotations.Nullable;
22
23 /**
24  * In some cases tests need to be extracted to a separate module (because they have a different classpath, output folder or JDK). E.g. when
25  * the project is imported from Gradle IDEA creates separate modules for each source set of a Gradle project.
26  * <p/>
27  * This service allows to specify to which production module the tests module belongs. This information may be used for example by
28  * 'Create Test' feature.
29  * <p/>
30  * <strong>This API isn't stable for now and may be changed in future. Also it isn't possible to change this in UI.</strong>
31  * @author nik
32  */
33 public abstract class TestModuleProperties {
34   public static TestModuleProperties getInstance(@NotNull Module module) {
35     return ModuleServiceManager.getService(module, TestModuleProperties.class);
36   }
37
38   @Nullable
39   public abstract String getProductionModuleName();
40
41   @Nullable
42   public abstract Module getProductionModule();
43
44   public abstract void setProductionModuleName(@Nullable String moduleName);
45 }