public interface IBuildLaunchUtils
Modifier and Type | Method and Description |
---|---|
String |
askToolPath(String archpath,
String toolName)
Given a tool's name, ask the user for the location of the tool
|
String |
askToolPath(String archpath,
String toolText,
String toolMessage)
Given a string as a starting point, this asks the user for the location of a tool's directory
|
String |
checkToolEnvPath(String toolname)
This locates the directory containing the given tool.
|
String |
findToolBinPath(String toolfind,
String suggPath,
String toolName)
Returns the directory containing the tool's executable file.
|
String |
findToolBinPath(String toolfind,
String suggPath,
String queryText,
String queryMessage)
Returns the directory containing the tool's executable file.
|
void |
getAllToolPaths(ExternalToolProcess[] tools,
boolean force)
Iterates through an array of tools, populating the preference store with their binary directory locations
|
IFileStore |
getFile(String path)
Convenience method to return the the given file as located by the IBuildLaunch object's file store
|
String |
getToolPath(String toolID)
Given a tool's ID, returns the path to that tool's bin directory if already known and stored locally, otherwise returns the
empty string
|
String |
getWorkingDirectory()
Returns the working directory associated with this object's remote connection, if any.
|
boolean |
isRemote()
Returns true if this object is configured with a remote connection, false if it is using a local connection.
|
boolean |
runTool(List<String> tool,
Map<String,String> env,
String directory)
Launches a command on the local system.
|
boolean |
runTool(List<String> tool,
Map<String,String> env,
String directory,
String output) |
byte[] |
runToolGetOutput(List<String> tool,
Map<String,String> env,
String directory) |
byte[] |
runToolGetOutput(List<String> tool,
Map<String,String> env,
String directory,
boolean showErr) |
void |
runVis(List<String> tool,
Map<String,String> env,
String directory)
Attempt to launch a UI based application.
|
void |
verifyRequestToolPath(ExternalToolProcess tool,
boolean force)
Associate the filesystem location of this tool's executable with its group
|
String askToolPath(String archpath, String toolName)
String askToolPath(String archpath, String toolText, String toolMessage)
String checkToolEnvPath(String toolname)
The
- name of the tool whose directory is being locatedString findToolBinPath(String toolfind, String suggPath, String toolName)
toolfind
- The name of the executable being soughtsuggPath
- The suggested path upon which to focus the directory locator windowtoolName
- The name of the tool used when prompting the user for its locationselshell
- The shell in which to launch the directory locator windowString findToolBinPath(String toolfind, String suggPath, String queryText, String queryMessage)
toolfind
- The name of the executable being soughtsuggPath
- The suggested path upon which to focus the directory locator windowqueryText
- The text asking the user to search for the binaryqueryMessage
- The text providing more detail on the search taskselshell
- The shell in which to launch the directory locator windowvoid getAllToolPaths(ExternalToolProcess[] tools, boolean force)
tools
- The array of tools to be checkedforce
- If true existing values will be overridden.IFileStore getFile(String path)
path
- String getToolPath(String toolID)
toolID
- String getWorkingDirectory()
boolean isRemote()
boolean runTool(List<String> tool, Map<String,String> env, String directory)
tool
- The command to be runenv
- A list of environment variables to associate with the tooldirectory
- The directory where the tool is invokedboolean runTool(List<String> tool, Map<String,String> env, String directory, String output)
tool
- The command to be runenv
- A list of environment variables to associate with the tooldirectory
- The directory where the tool is invokedoutput
- The path to the file where the output should be writtenbyte[] runToolGetOutput(List<String> tool, Map<String,String> env, String directory)
tool
- The command to be run, including argumentsenv
- A list of environment variables to associate with the tooldirectory
- The directory where the tool is invokedbyte[] runToolGetOutput(List<String> tool, Map<String,String> env, String directory, boolean showErr)
showErr
- set to true if the stderr from the program should be included in the output, otherwise falsevoid runVis(List<String> tool, Map<String,String> env, String directory)
tool
- The command to be run, including argumentsenv
- A list of environment variables to associate with the tooldirectory
- The directory where the tool is invokedvoid verifyRequestToolPath(ExternalToolProcess tool, boolean force)
tool
- The object containing the tool to be locatedforce
- if true proceed with the check and association even if there is already a path associated with the groupCopyright (c) 2011 IBM Corporation and others. All Rights Reserved.