|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Builder
This interface defines a Build tool plugin.
Method Summary | |
---|---|
Map |
addDefaultLabelPathMaps(Map labelPathMaps)
|
void |
addDefaultValues(BuildConfiguration configuration)
|
BuildResults |
build(Build build,
BuildResults preBuildResults)
Build the given build |
void |
collateTestResults(BuildResults buildInfo)
temp will morph into a TestResultsHanlder on route to a plugin! |
Map |
customiseLabelPathMaps(Map labelPathMaps)
Allows the builder to add extra LabelPathMap objects as required |
Map |
filterParameters(Map incomingWebParams)
Filter the parameters the builder needs from the incoming web parameters. |
String |
getBuildJdk()
The label of the JDK we're using |
String |
getCompleteKey()
Returns the full plugin descriptor key |
String |
getEditHtml(Map errors)
|
String |
getEnvironmentVariables()
Provides the ui form with the build's virtual machine parameters |
FilteredMap |
getFilteredParams()
|
String |
getFreemarkerEditHtml(Map errors)
|
Map |
getFullParams()
Subclasses should extend this method rather than getFilteredParams() since it calls back on this method
(getFillParams) |
String |
getKey()
|
String |
getLabel()
|
String |
getName()
|
String |
getPath()
The home path of the builder's command line |
String |
getPathHelp()
|
String |
getTestResultsDirectory()
Where are the build's xml test results files? |
String |
getViewHtml()
Returns the HTML representing the builder configuration for the build |
boolean |
hasTests()
Does the build have any tests to be included in the build results web pages? |
void |
init(ModuleDescriptor moduleDescriptor)
Initialises the Builder with the plugin module descriptor |
boolean |
isLabelPathMapConfigurable()
Returns true if the Builder can have its LabelPathMap configurable. |
boolean |
isPathValid(String path)
Returns true if the passed path is valid for this builder. |
void |
setAdminConfig(AdministrationConfiguration adminConfig)
|
void |
setBuildDir(File buildDirectory)
Set the location of the build files. |
void |
setBuilderManager(BuilderManager builderManager)
|
void |
setBuildJdk(String buildJdk)
The label of the JDK we're using |
void |
setEnvironmentVariables(String envVars)
Specify the optional build vm params |
void |
setHasTests(boolean hasTests)
Does the build have any tests to be included in the build results web pages? |
void |
setLabel(String label)
|
void |
setParams(FilteredMap params)
|
ErrorCollection |
validate()
Validate the Builder's current internal settings are still valid |
ErrorCollection |
validate(BuildConfiguration buildConfiguration)
|
ErrorCollection |
validate(FilteredMap filteredParams)
Validate the Builder's property settings when supplied from an web form |
Method Detail |
---|
void init(ModuleDescriptor moduleDescriptor)
moduleDescriptor
- BuildResults build(Build build, BuildResults preBuildResults)
build
- The build to buildpreBuildResults
- The change list that triggered the build
void collateTestResults(BuildResults buildInfo)
String getTestResultsDirectory()
void setBuildDir(File buildDirectory)
buildDirectory
- The build directoryErrorCollection validate(FilteredMap filteredParams)
filteredParams
-
ErrorCollection validate(BuildConfiguration buildConfiguration)
void addDefaultValues(BuildConfiguration configuration)
ErrorCollection validate()
boolean hasTests()
void setHasTests(boolean hasTests)
hasTests
- True if the build should have tests.void setEnvironmentVariables(String envVars)
envVars
- The paramsString getEnvironmentVariables()
void setBuildJdk(String buildJdk)
buildJdk
- The labelString getBuildJdk()
String getPath()
Map filterParameters(Map incomingWebParams)
incomingWebParams
- Raw build parameters coming from BuildPage action
String getKey()
void setParams(FilteredMap params)
Map getFullParams()
getFilteredParams()
since it calls back on this method
(getFillParams)
FilteredMap getFilteredParams()
String getCompleteKey()
String getEditHtml(Map errors)
String getViewHtml()
boolean isLabelPathMapConfigurable()
LabelPathMap
configurable. If it can't be, it won't be displayed
on the ConfigureBuilder page.
LabelPathMap
is configurableMap customiseLabelPathMaps(Map labelPathMaps)
LabelPathMap
objects as required
labelPathMaps
- may be nullboolean isPathValid(String path)
path
-
void setAdminConfig(AdministrationConfiguration adminConfig)
void setBuilderManager(BuilderManager builderManager)
String getLabel()
String getName()
String getPathHelp()
void setLabel(String label)
Map addDefaultLabelPathMaps(Map labelPathMaps)
String getFreemarkerEditHtml(Map errors)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |