|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Build
This interface describes a Bamboo Build.
Field Summary | |
---|---|
static int |
MAX_NUMBER_LOG_ENTRIES
|
static int |
MAX_PREVIOUS_BUILD_FOR_AVE
|
static String |
STATUS_CURRENTLY_BUILDING
|
static String |
STATUS_FAIL
|
static String |
STATUS_NO_BUILDS
|
static String |
STATUS_SUCCESS
|
Method Summary | |
---|---|
String |
addBuildLogEntry(LogEntry logEntry)
Add a new build log entry. |
void |
addBuildResultSummary(BuildResultsSummary buildResultsSummary)
Add the given build results summary to the build. |
void |
clearBuildLog()
Reset the build log, ready for the next build |
long |
getAverageBuildDuration()
Returns an average duration of the recent builds |
BuildDefinition |
getBuildDefinition()
Returns the BuildDefinition that backs this buildd |
BuildDefinitionForBuild |
getBuildDefinitionXml()
|
String |
getBuildKey()
Thie returns the build portion of the build key |
List |
getBuildLog()
Provide the latest build details. |
String |
getBuildName()
|
List |
getBuildResultSummaries()
Obtains the builds total collection of BuildResultsSummary objects
(oldest first), one for each build. |
Set |
getChildBuilds()
|
BuildStrategy |
getCurrentBuildStrategy()
What is the builds current BuildStrategy ?
It uses the value once and then reverts back to the default strategy. |
String |
getCurrentStatus()
Retuns a string key as to what the status is. |
int |
getFirstBuildNumber()
What the number of the first build we have? It may not be 1 as some may have been removed! |
BuildResultsSummary |
getFirstBuildSummary()
|
String |
getKey()
Obtain the build's unique key (uppercase alphanumeric). |
List |
getLabellings()
|
int |
getLastBuildNumber()
What was the number of the lastest build (may be being built) |
Date |
getLastBuildStartTime()
When was the last time this build was built? |
BuildResultsSummary |
getLatestBuildSummary()
Get the summary from the latest build |
String |
getName()
Returns the full name for the build in the form of "projet name - build name" e.g. |
int |
getNextBuildNumber()
|
BuildResults |
getNextBuildResults(int buildNumber)
|
Set |
getParentBuilds()
|
BuildResults |
getPreviousBuildResults(int buildNumber)
Gets the first BuildResultsImpl before the passed number |
Project |
getProject()
Returns the parent Project |
File |
getSourceCodeDirectory()
Returns a file representing the source directory from the Repository |
boolean |
hasBuildResults()
Has the build got any build results to display? |
boolean |
isInBuildQueue()
Is the build currenlty being built? |
boolean |
isMarkedForDeletion()
Whether or not the build has been marked for deletion |
boolean |
isMarkedForDependencyBuild()
Has the build been marked for a build following a dependent build having completed? |
boolean |
isMarkedForEditBuild()
Has the build been marked for a build following an edit? |
boolean |
isMarkedForManualBuild()
Has the build been marked for a manual build? |
boolean |
isSuspendedFromBuilding()
Checks if the build has been |
void |
markAsNeedingBuilding(ReasonForBuild reasonForBuild)
Mark the build to force a build next time it's checked. |
void |
markForDeletion()
Marks the build to be deleted. |
void |
removeBuildResultSummary(long buildNumber)
Remove the given build summary from the build |
int |
retrieveNextBuildNumber()
|
void |
setBuildDefinitionXml(BuildDefinitionForBuild buildDefinitionXml)
|
void |
setBuildKey(String buildKey)
Define the build's unique key (uppercase alphanumeric) |
void |
setBuildName(String buildName)
|
void |
setChildBuilds(Set childBuilds)
|
void |
setFirstBuildNumber(int firstBuildNumber)
|
void |
setInBuildQueue(boolean isBuilding)
Set the is-building flag. |
void |
setKey(String fullKey)
|
void |
setLabellings(List labellings)
|
void |
setLastBuildNumber(int lastBuildNumber)
|
void |
setLastBuildStartTime(Date lastBuildTime)
Set the time of the last build |
void |
setNextBuildNumber(int nextBuildNumber)
|
void |
setParentBuilds(Set parentBuilds)
|
void |
setProject(Project project)
|
void |
setSuspendedFromBuilding(boolean suspendFromBuilding)
Sets the build to suspend temporarily |
void |
unmarkBuild()
Clear all the build flags. |
ErrorCollection |
validateBuild()
Validates the build's builder and source code locations |
Methods inherited from interface com.atlassian.bamboo.core.BambooObject |
---|
getId, setId |
Field Detail |
---|
static final int MAX_NUMBER_LOG_ENTRIES
static final int MAX_PREVIOUS_BUILD_FOR_AVE
static final String STATUS_FAIL
static final String STATUS_SUCCESS
static final String STATUS_CURRENTLY_BUILDING
static final String STATUS_NO_BUILDS
Method Detail |
---|
String getKey()
void setKey(String fullKey)
String getBuildKey()
void setBuildKey(String buildKey)
buildKey
- The value of the keyString getName()
String getBuildName()
void setBuildName(String buildName)
ErrorCollection validateBuild()
ErrorCollection
with relevent error messagesString getCurrentStatus()
BuildStrategy getCurrentBuildStrategy()
BuildStrategy
?
It uses the value once and then reverts back to the default strategy. This lets you override the strategy once
and the system will revert to the default behaviour.
long getAverageBuildDuration()
File getSourceCodeDirectory()
Repository
boolean isInBuildQueue()
void setInBuildQueue(boolean isBuilding)
isBuilding
- Is the build currently in the build pipeline?boolean isMarkedForManualBuild()
boolean isMarkedForEditBuild()
boolean isMarkedForDependencyBuild()
void markAsNeedingBuilding(ReasonForBuild reasonForBuild)
reasonForBuild
- The reason we want to build the buildvoid unmarkBuild()
void markForDeletion()
boolean isMarkedForDeletion()
void setSuspendedFromBuilding(boolean suspendFromBuilding)
suspendFromBuilding
- boolean isSuspendedFromBuilding()
List getBuildLog()
SimpleLogEntry
s. Never returns null.String addBuildLogEntry(LogEntry logEntry)
logEntry
- The data being logged
LogEntry.getUnstyledLog()
.void clearBuildLog()
List getBuildResultSummaries()
BuildResultsSummary
objects
(oldest first), one for each build.
BuildResultsSummary getLatestBuildSummary()
int getLastBuildNumber()
int getFirstBuildNumber()
BuildResultsSummary getFirstBuildSummary()
Date getLastBuildStartTime()
void setLastBuildStartTime(Date lastBuildTime)
lastBuildTime
- the timeboolean hasBuildResults()
void addBuildResultSummary(BuildResultsSummary buildResultsSummary)
buildResultsSummary
- The build summaryvoid removeBuildResultSummary(long buildNumber)
buildNumber
- the number of the build to deleteBuildResults getPreviousBuildResults(int buildNumber)
BuildResultsImpl
before the passed number
buildNumber
-
BuildResultsImpl
. null if no build results can be found before that numberBuildResults getNextBuildResults(int buildNumber)
BuildDefinition getBuildDefinition()
BuildDefinition
that backs this buildd
BuildDefinition
object. Never null.Project getProject()
Project
Project
. Never nullvoid setProject(Project project)
int retrieveNextBuildNumber()
void setNextBuildNumber(int nextBuildNumber)
int getNextBuildNumber()
void setLastBuildNumber(int lastBuildNumber)
void setFirstBuildNumber(int firstBuildNumber)
BuildDefinitionForBuild getBuildDefinitionXml()
void setBuildDefinitionXml(BuildDefinitionForBuild buildDefinitionXml)
List getLabellings()
void setLabellings(List labellings)
Set getParentBuilds()
void setParentBuilds(Set parentBuilds)
Set getChildBuilds()
void setChildBuilds(Set childBuilds)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |