simplify GTDUCollector a bit more
[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.Nls;
32 import org.jetbrains.annotations.NotNull;
33 import org.jetbrains.annotations.Nullable;
34
35 import javax.swing.*;
36 import java.util.ArrayList;
37 import java.util.List;
38
39 public abstract class ModuleElementTypeBase<E extends ModulePackagingElementBase> extends PackagingElementType<E> {
40   public ModuleElementTypeBase(String id, @Nls(capitalization = Nls.Capitalization.Title) String presentableName) {
41     super(id, presentableName);
42   }
43
44   @Override
45   public boolean canCreate(@NotNull ArtifactEditorContext context, @NotNull Artifact artifact) {
46     return !getSuitableModules(context).isEmpty();
47   }
48
49   @Override
50   @NotNull
51   public List<? extends PackagingElement<?>> chooseAndCreate(@NotNull ArtifactEditorContext context, @NotNull Artifact artifact,
52                                                                        @NotNull CompositePackagingElement<?> parent) {
53     List<Module> suitableModules = getSuitableModules(context);
54     List<Module> selected = context.chooseModules(suitableModules, JavaCompilerBundle.message("dialog.title.packaging.choose.module"));
55
56     final List<PackagingElement<?>> elements = new ArrayList<>();
57     final ModulePointerManager pointerManager = ModulePointerManager.getInstance(context.getProject());
58     for (Module module : selected) {
59       elements.add(createElement(context.getProject(), pointerManager.create(module)));
60     }
61     return elements;
62   }
63
64   protected abstract ModulePackagingElementBase createElement(@NotNull Project project, @NotNull ModulePointer pointer);
65
66   private List<Module> getSuitableModules(ArtifactEditorContext context) {
67     ModulesProvider modulesProvider = context.getModulesProvider();
68     ArrayList<Module> modules = new ArrayList<>();
69     for (Module module : modulesProvider.getModules()) {
70       if (isSuitableModule(modulesProvider, module)) {
71         modules.add(module);
72       }
73     }
74     return modules;
75   }
76
77   public abstract boolean isSuitableModule(@NotNull ModulesProvider modulesProvider, @NotNull Module module);
78
79   /**
80    * Provides element presentation text.
81    * @param moduleName name of the module for which this presentation is requested.
82    * @return text to display.
83    */
84   @NotNull
85   public abstract String getElementText(@NotNull String moduleName);
86
87   public Icon getElementIcon(@Nullable Module module) {
88     return module != null ? ModuleType.get(module).getIcon() : AllIcons.Modules.Output;
89   }
90 }