IBuildDriver Interface
- public interface IBuildDriver
extends IProjectDriver
Driver provides build related information for an IProject specific to its project type.
Its primary function is to manage the ant script used to build the project.
In addition, it controls how the project classpath and sourcepath are formulated.
When the IProject is updating the build classpath for the project, it will first
ask the build driver for the server-, application-, and project-level classpath components
to use for the full classpath.
Project types and their associated drivers are registered with the IDE at startup
using extension xml. See IProject
and
IProjectInfo
for details on how project drivers
are declared and added to an IProject.
-
All Known Implementing Classes
-
DefaultBuildDriver
-
All Superinterfaces
-
IProjectDriver
getAntClassPath() Method
public String
[] getAntClassPath()
Returns the list of jars that should be put on the system classpath
of the ant thread executing this driver's ant script.
Jar's containing custom ant task implementations should be included in this list.
Returns
- Array of jar paths
getAntScript() Method
public String
getAntScript()
Return an ant script xml string to use for performing build operations on this project.
The returned string may be exported to disk as an ant file.
The script can assume the ant base directory will be set to the project root directory.
When executed from the IDE, local directory properties will be set, as well as any
build option properties.
Returns
- String ant script
getApplicationClassPath(String[]) Method
public String
[] getApplicationClassPath(String
[] cpApplication)
Returns the application-level build classpath.
A build driver that puts its build output in the application libraries
or modules folder should remove those jars from the application
classpath.
Parameters
-
cpApplication
- The current application-level classpath array. Includes all
application Library and Module jars, and APP-INF/classes if it exists.
Returns
- application classpath, potentially modifed
getBuildPropertyPanel() Method
public IProjectPropertyPanel
getBuildPropertyPanel()
Returns a panel for editing build properties managed by this driver.
The panel will get and set properties on the IProject referenced by the
driver. Components in the panel will be disabled if the user has chosen
to use an external ant script.
If this driver does not need to display build properties,
this method will return null.
Returns
- IPropertyPanel, null if this driver does not display build properties.
getPathsPropertyPanel() Method
public IProjectPropertyPanel
getPathsPropertyPanel()
Returns a panel for editing paths used by this driver,
typically classpath and source path. If this driver does not
support configurable path settings, this method will return null.
Returns
- IProjectPropertyPanel, null if this driver does not support paths properties.
getProjectClassPath() Method
public String
[] getProjectClassPath()
Returns a list of any project level libraries or directories that should
be included in the build classpath.
Returns
- project-level classpath array.
getServerClassPath(String[]) Method
public String
[] getServerClassPath(String
[] cpServer)
Returns the server-level build classpath for the project.
Typically, the driver will not modify the current default server classpath.
Parameters
-
cpServer
- Server classpath array.
Returns
- server classpath array to use for the project.