run configuration: add @NotNull
[idea/community.git] / platform / lang-api / src / com / intellij / execution / configurations / ConfigurationFactory.java
1 /*
2  * Copyright 2000-2009 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.execution.configurations;
17
18 import com.intellij.execution.BeforeRunTask;
19 import com.intellij.execution.RunManager;
20 import com.intellij.openapi.project.Project;
21 import com.intellij.openapi.util.Key;
22 import com.intellij.util.IconUtil;
23 import org.jetbrains.annotations.NotNull;
24
25 import javax.swing.*;
26
27 /**
28  * Factory for run configuration instances.
29  *
30  * @see com.intellij.execution.configurations.ConfigurationType#getConfigurationFactories()
31  * @author dyoma
32  */
33 public abstract class ConfigurationFactory {
34   public static final Icon ADD_ICON = IconUtil.getAddIcon();
35
36   private final ConfigurationType myType;
37
38   protected ConfigurationFactory(@NotNull final ConfigurationType type) {
39     myType = type;
40   }
41
42   /**
43    * Creates a new run configuration with the specified name by cloning the specified template.
44    *
45    * @param name the name for the new run configuration.
46    * @param template the template from which the run configuration is copied
47    * @return the new run configuration.
48    */
49   public RunConfiguration createConfiguration(String name, RunConfiguration template) {
50     RunConfiguration newConfiguration = template.clone();
51     newConfiguration.setName(name);
52     return newConfiguration;
53   }
54
55   /**
56    * Override this method and return {@code false} to hide the configuration from 'New' popup in 'Edit Configurations' dialog. It will be
57    * still possible to create this configuration by clicking on '42 more items' in the 'New' popup.
58    *
59    * @return {@code true} if it makes sense to create configurations of this type in {@code project}
60    */
61   public boolean isApplicable(@NotNull Project project) {
62     return true;
63   }
64
65   /**
66    * Creates a new template run configuration within the context of the specified project.
67    *
68    * @param project the project in which the run configuration will be used
69    * @return the run configuration instance.
70    */
71   @NotNull
72   public abstract RunConfiguration createTemplateConfiguration(@NotNull Project project);
73
74   @NotNull
75   public RunConfiguration createTemplateConfiguration(@NotNull Project project, @NotNull RunManager runManager) {
76     return createTemplateConfiguration(project);
77   }
78
79   /**
80    * Returns the name of the run configuration variant created by this factory.
81    *
82    * @return the name of the run configuration variant created by this factory
83    */
84   public String getName() {
85     return myType.getDisplayName();
86   }
87
88   public Icon getAddIcon() {
89     return ADD_ICON;
90   }
91
92   public Icon getIcon(@NotNull final RunConfiguration configuration) {
93     return getIcon();
94   }
95
96   public Icon getIcon() {
97     return myType.getIcon();
98   }
99
100   @NotNull
101   public ConfigurationType getType() {
102     return myType;
103   }
104
105   /**
106    * In this method you can configure defaults for the task, which are preferable to be used for your particular configuration type
107    * @param providerID
108    * @param task
109    */
110   public void configureBeforeRunTaskDefaults(Key<? extends BeforeRunTask> providerID, BeforeRunTask task) {
111   }
112
113   public boolean isConfigurationSingletonByDefault() {
114     return false;
115   }
116
117   public boolean canConfigurationBeSingleton() {
118     return true; // Configuration may be marked as singleton by default
119   }
120 }