a3acdf10e5075bb31d100fe84407c8b04257894e
[idea/community.git] / java / compiler / impl / src / com / intellij / packaging / impl / elements / ModuleElementTypeBase.java
1 /*
2  * Copyright 2000-2011 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.packaging.impl.elements;
17
18 import com.intellij.icons.AllIcons;
19 import com.intellij.openapi.compiler.JavaCompilerBundle;
20 import com.intellij.openapi.module.Module;
21 import com.intellij.openapi.module.ModulePointer;
22 import com.intellij.openapi.module.ModulePointerManager;
23 import com.intellij.openapi.module.ModuleType;
24 import com.intellij.openapi.project.Project;
25 import com.intellij.openapi.roots.ui.configuration.ModulesProvider;
26 import com.intellij.packaging.artifacts.Artifact;
27 import com.intellij.packaging.elements.CompositePackagingElement;
28 import com.intellij.packaging.elements.PackagingElement;
29 import com.intellij.packaging.elements.PackagingElementType;
30 import com.intellij.packaging.ui.ArtifactEditorContext;
31 import org.jetbrains.annotations.NotNull;
32 import org.jetbrains.annotations.Nullable;
33
34 import javax.swing.*;
35 import java.util.ArrayList;
36 import java.util.List;
37
38 public abstract class ModuleElementTypeBase<E extends ModulePackagingElementBase> extends PackagingElementType<E> {
39   public ModuleElementTypeBase(String id, String presentableName) {
40     super(id, presentableName);
41   }
42
43   @Override
44   public boolean canCreate(@NotNull ArtifactEditorContext context, @NotNull Artifact artifact) {
45     return !getSuitableModules(context).isEmpty();
46   }
47
48   @Override
49   @NotNull
50   public List<? extends PackagingElement<?>> chooseAndCreate(@NotNull ArtifactEditorContext context, @NotNull Artifact artifact,
51                                                                        @NotNull CompositePackagingElement<?> parent) {
52     List<Module> suitableModules = getSuitableModules(context);
53     List<Module> selected = context.chooseModules(suitableModules, JavaCompilerBundle.message("dialog.title.packaging.choose.module"));
54
55     final List<PackagingElement<?>> elements = new ArrayList<>();
56     final ModulePointerManager pointerManager = ModulePointerManager.getInstance(context.getProject());
57     for (Module module : selected) {
58       elements.add(createElement(context.getProject(), pointerManager.create(module)));
59     }
60     return elements;
61   }
62
63   protected abstract ModulePackagingElementBase createElement(@NotNull Project project, @NotNull ModulePointer pointer);
64
65   private List<Module> getSuitableModules(ArtifactEditorContext context) {
66     ModulesProvider modulesProvider = context.getModulesProvider();
67     ArrayList<Module> modules = new ArrayList<>();
68     for (Module module : modulesProvider.getModules()) {
69       if (isSuitableModule(modulesProvider, module)) {
70         modules.add(module);
71       }
72     }
73     return modules;
74   }
75
76   public abstract boolean isSuitableModule(@NotNull ModulesProvider modulesProvider, @NotNull Module module);
77
78   /**
79    * Provides element presentation text.
80    * @param moduleName name of the module for which this presentation is requested.
81    * @return text to display.
82    */
83   @NotNull
84   public abstract String getElementText(@NotNull String moduleName);
85
86   public Icon getElementIcon(@Nullable Module module) {
87     return module != null ? ModuleType.get(module).getIcon() : AllIcons.Modules.Output;
88   }
89 }