javadocs

platform/lang-api/src/com/intellij/execution/RunnerAndConfigurationSettings.java

@@ -26,6 +26,7 @@ import org.jetbrains.annotations.Nullable;
  * settings.
  *
  * @author anna
+ * @see RunManager#createRunConfiguration(String, com.intellij.execution.configurations.ConfigurationFactory)
  */
 public interface RunnerAndConfigurationSettings {
   /**
@@ -37,44 +38,147 @@ public interface RunnerAndConfigurationSettings {
   @Nullable
   ConfigurationType getType();
 
+  /**
+   * Returns the factory used to create the run configuration.
+   *
+   * @return the factory, or null if the settings object was loaded from disk and no plugin corresponding to the stored type of the run
+   * configuration is loaded.
+   */
   @Nullable
   ConfigurationFactory getFactory();
 
+  /**
+   * Returns true if this configuration settings object represents a template used to create other configurations of the same type
+   * (in other words, an item under the "Defaults" node of the Run/Debug Configurations dialog).
+   *
+   * @return true if the configuration is a template, false otherwise.
+   */
   boolean isTemplate();
 
+  /**
+   * Returns true if this configuration is temporary and will be deleted when the temporary configurations limit is exceeded.
+   *
+   * @return true if the configuration is temporary, false otherwise.
+   */
   boolean isTemporary();
 
+  /**
+   * Marks the configuration as temporary or permanent.
+   *
+   * @param temporary true if the configuration is temporary, false if it's permanent.
+   */
+  void setTemporary(boolean temporary);
+
+  /**
+   * Returns the {@link RunConfiguration} instance that will be used to execute this run configuration.
+   *
+   * @return the run configuration, or null if the settings object was loaded from disk and no plugin corresponding to the stored type
+   * of the run configuration is loaded.
+   */
   RunConfiguration getConfiguration();
 
+  /**
+   * Sets the name of the configuration.
+   *
+   * @param name the name of the configuration
+   */
   void setName(String name);
 
+  /**
+   * Returns the name of the configuration.
+   *
+   * @return the name of the configuration.
+   */
   String getName();
 
+  /**
+   * Returns the runner-managed settings for the specified runner.
+   *
+   * @param runner the runner for which the settings are requested.
+   * @return the settings, or null if the runner doesn't provide any settings or the settings aren't configured for this configuration.
+   */
   @Nullable
   RunnerSettings getRunnerSettings(@NotNull ProgramRunner runner);
 
+  /**
+   * Returns the configuration-managed settings for the specified runner.
+   *
+   * @param runner the runner for which the settings are requested.
+   * @return the settings, or null if the configuration doesn't provide any settings specific to this runner or the settings aren't
+   * configured for this configuration.
+   */
   @Nullable
   ConfigurationPerRunnerSettings getConfigurationSettings(@NotNull ProgramRunner runner);
 
+  /**
+   * Checks whether the run configuration settings are valid.
+   *
+   * @throws RuntimeConfigurationException if the configuration settings contain a non-fatal problem which the user should be warned about
+   * but the execution should still be allowed
+   * @throws RuntimeConfigurationError if the configuration settings contain a fatal problem which makes it impossible to execute the run
+   * configuration.
+   */
   void checkSettings() throws RuntimeConfigurationException;
 
+  /**
+   * Checks whether the run configuration settings are valid for execution with the specified executor.
+   *
+   * @param executor the executor which will be used to run the configuration, or null if the check is not specific to an executor.
+   * @throws RuntimeConfigurationException if the configuration settings contain a non-fatal problem which the user should be warned about
+   * but the execution should still be allowed
+   * @throws RuntimeConfigurationError if the configuration settings contain a fatal problem which makes it impossible to execute the run
+   * configuration.
+   */
   void checkSettings(@Nullable Executor executor) throws RuntimeConfigurationException;
 
   boolean canRunOn(@NotNull ExecutionTarget target);
 
-  void setTemporary(boolean temporary);
-
+  /**
+   * Returns a factory object which can be used to create a copy of this configuration.
+   *
+   * @return copying factory instance
+   */
   Factory<RunnerAndConfigurationSettings> createFactory();
 
+  /**
+   * Sets the "Before launch: Show this page" flag (for showing the run configuration settings before execution).
+   *
+   * @param b if true, the settings dialog will be displayed before launching this configuration.
+   */
   void setEditBeforeRun(boolean b);
 
+  /**
+   * Returns the "Before launch: Show this page" flag (for showing the run configuration settings before execution).
+   *
+   * @return if true, the settings dialog will be displayed before launching this configuration.
+   */
   boolean isEditBeforeRun();
 
+  /**
+   * Sets the "Single instance only" flag (meaning that only one instance of this run configuration can be run at the same time).
+   *
+   * @param singleton the "Single instance" flag.
+   */
   void setSingleton(boolean singleton);
 
+  /**
+   * Returns the "Single instance only" flag (meaning that only one instance of this run configuration can be run at the same time).
+   *
+   * @return the "Single instance" flag.
+   */
   boolean isSingleton();
 
+  /**
+   * Sets the name of the folder under which the configuration is displayed in the "Run/Debug Configurations" dialog.
+   *
+   * @param folderName the folder name, or null if the configuration is displayed on the top level.
+   */
   void setFolderName(@Nullable String folderName);
 
+  /**
+   * Returns the name of the folder under which the configuration is displayed in the "Run/Debug Configurations" dialog.
+   *
+   * @return the folder name, or null if the configuration is displayed on the top level.
+   */
   @Nullable String getFolderName();
 }