org.eclipse.ptp.core.util

Class LaunchUtils

java.lang.Object

org.eclipse.ptp.core.util.LaunchUtils

public class LaunchUtils
extends Object

Utility methods for managing launch configuration attributes.

Since:

6.0

Constructor Summary

Constructors

Constructor and Description
LaunchUtils() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
static String	getArguments(ILaunchConfiguration configuration) Get the program arguments specified in the Arguments tab
static String	getConnectionName(ILaunchConfiguration configuration) Get the connection name specified in the Resources tab
static boolean	getCopyExecutable(ILaunchConfiguration configuration) Get if the executable shall be copied to remote target before launch.
static String	getDebuggerExePath(ILaunchConfiguration configuration) Get the debugger executable path
static String	getDebuggerID(ILaunchConfiguration configuration) Get the ID of the debugger for this launch
static boolean	getDebuggerStopInMainFlag(ILaunchConfiguration configuration) Get the debugger "stop in main" flag
static String	getDebuggerWorkDirectory(ILaunchConfiguration configuration) Get the working directory for this debug session
static String	getExecutablePath(ILaunchConfiguration configuration) Get the absolute path of the executable to launch.
static String[]	getProgramArguments(ILaunchConfiguration configuration) Convert application arguments to an array of strings.
static String	getProgramName(ILaunchConfiguration configuration) Get the name of the executable to launch
static String	getProgramPath(ILaunchConfiguration configuration) Get the path component of the executable to launch.
static IProject	getProject(String project) Get the IProject object from the project name.
static String	getProjectName(ILaunchConfiguration configuration) Get the name of the project
static String	getRemoteServicesId(ILaunchConfiguration configuration) Get the remote services ID specified in the Resources tab (possibly implicitly)
static String	getResourceManagerUniqueName(ILaunchConfiguration configuration) Get the target controller to use for the launch
static String	getSystemType(ILaunchConfiguration configuration) Given a launch configuration, find the system type that was been selected.
static String	getTemplateName(ILaunchConfiguration configuration) Given a launch configuration, find the template name that was been selected.
static String	getWorkingDirectory(ILaunchConfiguration configuration) Get the working directory for the application launch
static IWorkspaceRoot	getWorkspaceRoot() Get the workspace root.
static void	setConfigurationName(ILaunchConfigurationWorkingCopy configuration, String name) Set the name of the launch configuration
static void	setConnectionName(ILaunchConfigurationWorkingCopy configuration, String name) Set the connection name attribute
static void	setRemoteServicesId(ILaunchConfigurationWorkingCopy configuration, String id) Set the remote services ID attribute
static void	setResourceManagerUniqueName(ILaunchConfigurationWorkingCopy configuration, String id) Set the target controller used for the launch
static void	setSystemType(ILaunchConfigurationWorkingCopy configuration, String type) Set the target system type used for the launch
static void	setWorkingDirectory(ILaunchConfigurationWorkingCopy configuration, String dir) Set the working directory

Methods inherited from class java.lang.Object

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

Constructor Detail

LaunchUtils

public LaunchUtils()

Constructor

Method Detail

getArguments

public static String getArguments(ILaunchConfiguration configuration)
                           throws CoreException

Get the program arguments specified in the Arguments tab

Parameters:

configuration -

Returns:

program arguments string

Throws:

CoreException

getConnectionName

public static String getConnectionName(ILaunchConfiguration configuration)

Get the connection name specified in the Resources tab

Parameters:

configuration -

Returns:

connection name

Since:

6.0

getCopyExecutable

public static boolean getCopyExecutable(ILaunchConfiguration configuration)
                                 throws CoreException

Get if the executable shall be copied to remote target before launch.

Parameters:

configuration -

Returns:

copy executable attribute

Throws:

CoreException

getDebuggerExePath

public static String getDebuggerExePath(ILaunchConfiguration configuration)
                                 throws CoreException

Get the debugger executable path

Parameters:

configuration -

Returns:

debugger executable path

Throws:

CoreException

getDebuggerID

public static String getDebuggerID(ILaunchConfiguration configuration)
                            throws CoreException

Get the ID of the debugger for this launch

Parameters:

configuration -

Returns:

debugger ID

Throws:

CoreException

getDebuggerStopInMainFlag

public static boolean getDebuggerStopInMainFlag(ILaunchConfiguration configuration)
                                         throws CoreException

Get the debugger "stop in main" flag

Parameters:

configuration -

Returns:

"stop in main" flag

Throws:

CoreException

getDebuggerWorkDirectory

public static String getDebuggerWorkDirectory(ILaunchConfiguration configuration)
                                       throws CoreException

Get the working directory for this debug session

Parameters:

configuration -

Returns:

working directory

Throws:

CoreException

getExecutablePath

public static String getExecutablePath(ILaunchConfiguration configuration)
                                throws CoreException

Get the absolute path of the executable to launch. If the executable is on a remote machine, this is the path to the executable on that machine.

Parameters:

configuration -

Returns:

executable path

Throws:

CoreException

getProgramArguments

public static String[] getProgramArguments(ILaunchConfiguration configuration)
                                    throws CoreException

Convert application arguments to an array of strings.

Parameters:

configuration - launch configuration

Returns:

array of strings containing the program arguments

Throws:

CoreException

getProgramName

public static String getProgramName(ILaunchConfiguration configuration)
                             throws CoreException

Get the name of the executable to launch

Parameters:

configuration -

Returns:

program name

Throws:

CoreException

getProgramPath

public static String getProgramPath(ILaunchConfiguration configuration)
                             throws CoreException

Get the path component of the executable to launch.

Parameters:

configuration -

Returns:

program path

Throws:

CoreException

Since:

5.0

getProject

public static IProject getProject(String project)

Get the IProject object from the project name.

Parameters:

project - name of the project

Returns:

IProject resource

getProjectName

public static String getProjectName(ILaunchConfiguration configuration)
                             throws CoreException

Get the name of the project

Parameters:

configuration -

Returns:

project name specified in the Application tab

Throws:

CoreException

getRemoteServicesId

public static String getRemoteServicesId(ILaunchConfiguration configuration)

Get the remote services ID specified in the Resources tab (possibly implicitly)

Parameters:

configuration -

Returns:

remote services ID

Since:

6.0

getResourceManagerUniqueName

public static String getResourceManagerUniqueName(ILaunchConfiguration configuration)

Get the target controller to use for the launch

Parameters:

configuration -

Returns:

Throws:

CoreException

getSystemType

public static String getSystemType(ILaunchConfiguration configuration)

Given a launch configuration, find the system type that was been selected.

Parameters:

configuration -

Returns:

resource manager type

Throws:

CoreException

Since:

6.0

getTemplateName

public static String getTemplateName(ILaunchConfiguration configuration)

Given a launch configuration, find the template name that was been selected.

Parameters:

configuration -

Returns:

resource manager type

Throws:

CoreException

Since:

6.0

getWorkingDirectory

public static String getWorkingDirectory(ILaunchConfiguration configuration)
                                  throws CoreException

Get the working directory for the application launch

Parameters:

configuration -

Returns:

Throws:

CoreException

Since:

5.0

getWorkspaceRoot

public static IWorkspaceRoot getWorkspaceRoot()

Get the workspace root.

Returns:

workspace root

setConnectionName

public static void setConnectionName(ILaunchConfigurationWorkingCopy configuration,
                     String name)

Set the connection name attribute

Parameters:

configuration -

name - connection name

Since:

6.0

setRemoteServicesId

public static void setRemoteServicesId(ILaunchConfigurationWorkingCopy configuration,
                       String id)

Set the remote services ID attribute

Parameters:

configuration -

id - remote services ID

Since:

6.0

setResourceManagerUniqueName

public static void setResourceManagerUniqueName(ILaunchConfigurationWorkingCopy configuration,
                                String id)

Set the target controller used for the launch

Parameters:

configuration -

Since:

6.0

setSystemType

public static void setSystemType(ILaunchConfigurationWorkingCopy configuration,
                 String type)

Set the target system type used for the launch

Parameters:

configuration -

type - target system type

Since:

6.0

setConfigurationName

public static void setConfigurationName(ILaunchConfigurationWorkingCopy configuration,
                        String name)

Set the name of the launch configuration

Parameters:

configuration -

name - configuration name

Since:

6.0

setWorkingDirectory

public static void setWorkingDirectory(ILaunchConfigurationWorkingCopy configuration,
                       String dir)
                                throws CoreException

Set the working directory

Parameters:

configuration -

dir -

Throws:

CoreException

Since:

5.0