| org.eclipse.jdt.launching.AbstractJavaLaunchConfigurationDelegate
All known Subclasses: org.eclipse.jdt.internal.launching.JavaRemoteApplicationLaunchConfigurationDelegate, org.eclipse.jdt.launching.JavaLaunchDelegate,
AbstractJavaLaunchConfigurationDelegate | abstract public class AbstractJavaLaunchConfigurationDelegate extends LaunchConfigurationDelegate implements IDebugEventSetListener(Code) | | Abstract implementation of a Java launch configuration delegate. Provides
convenience methods for accessing and verifying launch configuration
attributes.
Clients implementing Java launch configuration delegates should subclass this
class.
since: 2.0 |
Method Summary | |
protected void | abort(String message, Throwable exception, int code) Throws a core exception with an error status object built from the given
message, lower level exception, and error code. | public String[] | getBootpath(ILaunchConfiguration configuration) Returns entries that should appear on the bootstrap portion of the
classpath as specified by the given launch configuration, as an array of
resolved strings. | public String[][] | getBootpathExt(ILaunchConfiguration configuration) Returns three sets of entries which represent the boot classpath
specified in the launch configuration, as an array of three arrays of
resolved strings. | protected IBreakpoint[] | getBreakpoints(ILaunchConfiguration configuration) | protected IProject[] | getBuildOrder(ILaunchConfiguration configuration, String mode) | public String[] | getClasspath(ILaunchConfiguration configuration) Returns the entries that should appear on the user portion of the
classpath as specified by the given launch configuration, as an array of
resolved strings. | protected File | getDefaultWorkingDirectory(ILaunchConfiguration configuration) Returns the default working directory for the given launch configuration,
or null if none. | public String[] | getEnvironment(ILaunchConfiguration configuration) Returns an array of environment variables to be used when
launching the given configuration or null if unspecified. | public String[] | getJavaLibraryPath(ILaunchConfiguration configuration) Returns an array of paths to be used for the java.library.path
system property, or null if unspecified. | public IJavaProject | getJavaProject(ILaunchConfiguration configuration) Returns the Java project specified by the given launch configuration, or
null if none. | public String | getJavaProjectName(ILaunchConfiguration configuration) Returns the Java project name specified by the given launch
configuration, or null if none. | protected ILaunchManager | getLaunchManager() Convenience method to get the launch manager. | public String | getMainTypeName(ILaunchConfiguration configuration) Returns the main type name specified by the given launch configuration,
or null if none. | public String | getProgramArguments(ILaunchConfiguration configuration) Returns the program arguments specified by the given launch
configuration, as a string. | protected IProject[] | getProjectsForProblemSearch(ILaunchConfiguration configuration, String mode) | public String | getVMArguments(ILaunchConfiguration configuration) Returns the VM arguments specified by the given launch configuration, as
a string. | public String | getVMConnectorId(ILaunchConfiguration configuration) Returns the VM connector identifier specified by the given launch
configuration, or null if none. | public IVMInstall | getVMInstall(ILaunchConfiguration configuration) Returns the VM install specified by the given launch configuration, or
null if none. | public String | getVMInstallName(ILaunchConfiguration configuration) Returns the VM install name specified by the given launch configuration,
or null if none. | public IVMInstallType | getVMInstallType(ILaunchConfiguration configuration) Returns the VM install type specified by the given launch configuration,
or null if none. | public String | getVMInstallTypeId(ILaunchConfiguration configuration) Returns the VM install type identifier specified by the given launch
configuration, or null if none. | public IVMRunner | getVMRunner(ILaunchConfiguration configuration, String mode) Returns the VM runner for the given launch mode to use when launching the
given configuration. | public Map | getVMSpecificAttributesMap(ILaunchConfiguration configuration) Returns the Map of VM-specific attributes specified by the given launch
configuration, or null if none. | public File | getWorkingDirectory(ILaunchConfiguration configuration) Returns the working directory specified by the given launch
configuration, or null if none. | public IPath | getWorkingDirectoryPath(ILaunchConfiguration configuration) Returns the working directory path specified by the given launch
configuration, or null if none. | public void | handleDebugEvents(DebugEvent[] events) Handles the "stop-in-main" option. | public boolean | isAllowTerminate(ILaunchConfiguration configuration) Returns whether the given launch configuration specifies that termination
is allowed. | protected boolean | isLaunchProblem(IMarker problemMarker) | public boolean | isStopInMain(ILaunchConfiguration configuration) Returns whether the given launch configuration specifies that execution
should suspend on entry of the main method. | public boolean | preLaunchCheck(ILaunchConfiguration configuration, String mode, IProgressMonitor monitor) | protected void | prepareStopInMain(ILaunchConfiguration configuration) Determines if the given launch configuration specifies the "stop-in-main"
attribute, and sets up an event listener to handle the option if
required. | protected void | setDefaultSourceLocator(ILaunch launch, ILaunchConfiguration configuration) Assigns a default source locator to the given launch if a source locator
has not yet been assigned to it, and the associated launch configuration
does not specify a source locator. | public IJavaProject | verifyJavaProject(ILaunchConfiguration configuration) Verifies a Java project is specified by the given launch configuration,
and returns the Java project. | public String | verifyMainTypeName(ILaunchConfiguration configuration) Verifies a main type name is specified by the given launch configuration,
and returns the main type name. | public IVMInstall | verifyVMInstall(ILaunchConfiguration configuration) Verifies the VM install specified by the given launch configuration
exists and returns the VM install. | public File | verifyWorkingDirectory(ILaunchConfiguration configuration) Verifies the working directory specified by the given launch
configuration exists, and returns the working directory, or
null if none is specified. |
abort | protected void abort(String message, Throwable exception, int code) throws CoreException(Code) | | Throws a core exception with an error status object built from the given
message, lower level exception, and error code.
Parameters: message - the status message Parameters: exception - lower level exception associated with the error, ornull if none Parameters: code - error code throws: CoreException - the "abort" core exception |
getBootpath | public String[] getBootpath(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns entries that should appear on the bootstrap portion of the
classpath as specified by the given launch configuration, as an array of
resolved strings. The returned array is null if all
entries are standard (i.e. appear by default), or empty to represent an
empty bootpath.
Parameters: configuration - launch configuration the bootpath specified by the given launch configuration. Anempty bootpath is specified by an empty array, andnull represents a default bootpath. exception: CoreException - if unable to retrieve the attribute |
getBootpathExt | public String[][] getBootpathExt(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns three sets of entries which represent the boot classpath
specified in the launch configuration, as an array of three arrays of
resolved strings. The first array represents the classpath that should be
prepended to the boot classpath. The second array represents the main
part of the boot classpath -null represents the default
bootclasspath. The third array represents the classpath that should be
appended to the boot classpath.
Parameters: configuration - launch configuration a description of the boot classpath specified by the given launchconfiguration. exception: CoreException - if unable to retrieve the attribute since: 3.0 |
getBreakpoints | protected IBreakpoint[] getBreakpoints(ILaunchConfiguration configuration)(Code) | | |
getBuildOrder | protected IProject[] getBuildOrder(ILaunchConfiguration configuration, String mode) throws CoreException(Code) | | |
getClasspath | public String[] getClasspath(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns the entries that should appear on the user portion of the
classpath as specified by the given launch configuration, as an array of
resolved strings. The returned array is empty if no classpath is
specified.
Parameters: configuration - launch configuration the classpath specified by the given launch configuration,possibly an empty array exception: CoreException - if unable to retrieve the attribute |
getDefaultWorkingDirectory | protected File getDefaultWorkingDirectory(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns the default working directory for the given launch configuration,
or null if none. Subclasses may override as necessary.
Parameters: configuration - default working directory or null if none throws: CoreException - if an exception occurs computing the default workingdirectory since: 3.2 |
getEnvironment | public String[] getEnvironment(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns an array of environment variables to be used when
launching the given configuration or null if unspecified.
Parameters: configuration - launch configuration throws: CoreException - if unable to access associated attribute or ifunable to resolve a variable in an environment variable's value since: 3.1 |
getJavaLibraryPath | public String[] getJavaLibraryPath(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns an array of paths to be used for the java.library.path
system property, or null if unspecified.
Parameters: configuration - an array of paths to be used for the java.library.path system property, or null throws: CoreException - if unable to determine the attribute since: 3.1 |
getJavaProject | public IJavaProject getJavaProject(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns the Java project specified by the given launch configuration, or
null if none.
Parameters: configuration - launch configuration the Java project specified by the given launch configuration, ornull if none exception: CoreException - if unable to retrieve the attribute |
getJavaProjectName | public String getJavaProjectName(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns the Java project name specified by the given launch
configuration, or null if none.
Parameters: configuration - launch configuration the Java project name specified by the given launchconfiguration, or null if none exception: CoreException - if unable to retrieve the attribute |
getLaunchManager | protected ILaunchManager getLaunchManager()(Code) | | Convenience method to get the launch manager.
the launch manager |
getMainTypeName | public String getMainTypeName(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns the main type name specified by the given launch configuration,
or null if none.
Parameters: configuration - launch configuration the main type name specified by the given launch configuration,or null if none exception: CoreException - if unable to retrieve the attribute |
getProgramArguments | public String getProgramArguments(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns the program arguments specified by the given launch
configuration, as a string. The returned string is empty if no program
arguments are specified.
Parameters: configuration - launch configuration the program arguments specified by the given launchconfiguration, possibly an empty string exception: CoreException - if unable to retrieve the attribute |
getProjectsForProblemSearch | protected IProject[] getProjectsForProblemSearch(ILaunchConfiguration configuration, String mode) throws CoreException(Code) | | |
getVMArguments | public String getVMArguments(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns the VM arguments specified by the given launch configuration, as
a string. The returned string is empty if no VM arguments are specified.
Parameters: configuration - launch configuration the VM arguments specified by the given launch configuration,possibly an empty string exception: CoreException - if unable to retrieve the attribute |
getVMConnectorId | public String getVMConnectorId(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns the VM connector identifier specified by the given launch
configuration, or null if none.
Parameters: configuration - launch configuration the VM connector identifier specified by the given launchconfiguration, or null if none exception: CoreException - if unable to retrieve the attribute |
getVMInstall | public IVMInstall getVMInstall(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns the VM install specified by the given launch configuration, or
null if none.
Parameters: configuration - launch configuration the VM install specified by the given launch configuration, ornull if none exception: CoreException - if unable to retrieve the attribute |
getVMInstallName | public String getVMInstallName(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns the VM install name specified by the given launch configuration,
or null if none.
Parameters: configuration - launch configuration the VM install name specified by the given launch configuration,or null if none exception: CoreException - if unable to retrieve the attribute |
getVMInstallType | public IVMInstallType getVMInstallType(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns the VM install type specified by the given launch configuration,
or null if none.
Parameters: configuration - launch configuration the VM install type specified by the given launch configuration,or null if none exception: CoreException - if unable to retrieve the attribute |
getVMInstallTypeId | public String getVMInstallTypeId(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns the VM install type identifier specified by the given launch
configuration, or null if none.
Parameters: configuration - launch configuration the VM install type identifier specified by the given launchconfiguration, or null if none exception: CoreException - if unable to retrieve the attribute |
getVMRunner | public IVMRunner getVMRunner(ILaunchConfiguration configuration, String mode) throws CoreException(Code) | | Returns the VM runner for the given launch mode to use when launching the
given configuration.
Parameters: configuration - launch configuration Parameters: mode - launch node VM runner to use when launching the given configuration in the given mode throws: CoreException - if a VM runner cannot be determined since: 3.1 |
getVMSpecificAttributesMap | public Map getVMSpecificAttributesMap(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns the Map of VM-specific attributes specified by the given launch
configuration, or null if none.
Parameters: configuration - launch configuration the Map of VM-specific attributes exception: CoreException - if unable to retrieve the attribute |
getWorkingDirectory | public File getWorkingDirectory(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns the working directory specified by the given launch
configuration, or null if none.
Parameters: configuration - launch configuration the working directory specified by the given launchconfiguration, or null if none exception: CoreException - if unable to retrieve the attribute |
getWorkingDirectoryPath | public IPath getWorkingDirectoryPath(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns the working directory path specified by the given launch
configuration, or null if none.
Parameters: configuration - launch configuration the working directory path specified by the given launchconfiguration, or null if none exception: CoreException - if unable to retrieve the attribute |
handleDebugEvents | public void handleDebugEvents(DebugEvent[] events)(Code) | | Handles the "stop-in-main" option.
Parameters: events - the debug events. See Also: org.eclipse.debug.core.IDebugEventSetListener.handleDebugEvents(DebugEvent[]) |
isAllowTerminate | public boolean isAllowTerminate(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns whether the given launch configuration specifies that termination
is allowed.
Parameters: configuration - launch configuration whether termination is allowed exception: CoreException - if unable to retrieve the attribute |
isLaunchProblem | protected boolean isLaunchProblem(IMarker problemMarker) throws CoreException(Code) | | |
isStopInMain | public boolean isStopInMain(ILaunchConfiguration configuration) throws CoreException(Code) | | Returns whether the given launch configuration specifies that execution
should suspend on entry of the main method.
Parameters: configuration - launch configuration whether execution should suspend in main exception: CoreException - if unable to retrieve the attribute since: 2.1 |
preLaunchCheck | public boolean preLaunchCheck(ILaunchConfiguration configuration, String mode, IProgressMonitor monitor) throws CoreException(Code) | | |
prepareStopInMain | protected void prepareStopInMain(ILaunchConfiguration configuration) throws CoreException(Code) | | Determines if the given launch configuration specifies the "stop-in-main"
attribute, and sets up an event listener to handle the option if
required.
Parameters: configuration - configuration being launched exception: CoreException - if unable to access the attribute since: 2.1 |
setDefaultSourceLocator | protected void setDefaultSourceLocator(ILaunch launch, ILaunchConfiguration configuration) throws CoreException(Code) | | Assigns a default source locator to the given launch if a source locator
has not yet been assigned to it, and the associated launch configuration
does not specify a source locator.
Parameters: launch - launch object Parameters: configuration - configuration being launched exception: CoreException - if unable to set the source locator |
verifyJavaProject | public IJavaProject verifyJavaProject(ILaunchConfiguration configuration) throws CoreException(Code) | | Verifies a Java project is specified by the given launch configuration,
and returns the Java project.
Parameters: configuration - launch configuration the Java project specified by the given launch configuration exception: CoreException - if unable to retrieve the attribute or the attribute isunspecified |
verifyMainTypeName | public String verifyMainTypeName(ILaunchConfiguration configuration) throws CoreException(Code) | | Verifies a main type name is specified by the given launch configuration,
and returns the main type name.
Parameters: configuration - launch configuration the main type name specified by the given launch configuration exception: CoreException - if unable to retrieve the attribute or the attribute isunspecified |
verifyVMInstall | public IVMInstall verifyVMInstall(ILaunchConfiguration configuration) throws CoreException(Code) | | Verifies the VM install specified by the given launch configuration
exists and returns the VM install.
Parameters: configuration - launch configuration the VM install specified by the given launch configuration exception: CoreException - if unable to retrieve the attribute, the attribute isunspecified, or if the home location is unspecified ordoes not exist |
verifyWorkingDirectory | public File verifyWorkingDirectory(ILaunchConfiguration configuration) throws CoreException(Code) | | Verifies the working directory specified by the given launch
configuration exists, and returns the working directory, or
null if none is specified.
Parameters: configuration - launch configuration the working directory specified by the given launchconfiguration, or null if none exception: CoreException - if unable to retrieve the attribute |
|
|