Package com.intellij.javadoc

Class JavadocGeneratorRunProfile

java.lang.Object

com.intellij.javadoc.JavadocGeneratorRunProfile

All Implemented Interfaces:

ModuleRunProfile, RunProfile, RunProfileWithCompileBeforeLaunchOption, SearchScopeProvidingRunProfile

public class JavadocGeneratorRunProfile
extends java.lang.Object
implements ModuleRunProfile

Constructor Summary

Constructors

Constructor and Description
JavadocGeneratorRunProfile(Project project, AnalysisScope generationScope, JavadocConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
javax.swing.Icon	getIcon() Returns the icon for the run configuration.
java.lang.String	getName() Returns the name of the run configuration.
static Sdk	getSdk(Project project)
RunProfileState	getState(Executor executor, ExecutionEnvironment env) Prepares for executing a specific instance of the run configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.intellij.execution.configurations.ModuleRunProfile

getSearchScope

Methods inherited from interface com.intellij.execution.configurations.RunProfileWithCompileBeforeLaunchOption

getModules, isBuildBeforeLaunchAddedByDefault, isBuildProjectOnEmptyModuleList, isExcludeCompileBeforeLaunchOption

Constructor Detail

JavadocGeneratorRunProfile

public JavadocGeneratorRunProfile(Project project,
                                  AnalysisScope generationScope,
                                  JavadocConfiguration configuration)

Method Detail

getSdk

public static Sdk getSdk(Project project)

getState

public RunProfileState getState(Executor executor,
                                ExecutionEnvironment env)

Description copied from interface: RunProfile

Prepares for executing a specific instance of the run configuration.

Specified by:

getState in interface RunProfile

Parameters:

executor - the execution mode selected by the user (run, debug, profile etc.)

env - the environment object containing additional settings for executing the configuration.

Returns:

the RunProfileState describing the process which is about to be started, or null if it's impossible to start the process.

getName

public java.lang.String getName()

Description copied from interface: RunProfile

Returns the name of the run configuration.

Specified by:

getName in interface RunProfile

Returns:

the name of the run configuration.

getIcon

public javax.swing.Icon getIcon()

Description copied from interface: RunProfile

Returns the icon for the run configuration. This icon is displayed in the tab showing the results of executing the run profile, and for persistent run configurations is also used in the run configuration management UI.

Specified by:

getIcon in interface RunProfile

Returns:

the icon for the run configuration, or null if the default executor icon should be used.