Package com.atlassian.bamboo.resultsummary

Class BaseResultSummary

java.lang.Object

com.atlassian.core.bean.EntityObject

com.atlassian.bamboo.core.BambooEntityObject

com.atlassian.bamboo.resultsummary.BaseResultSummary

All Implemented Interfaces:

BambooIdProvider, BambooObject, ImmutableResultsSummary, ResultStatisticsProvider, Cloneable, Comparable<ImmutableResultsSummary>

Direct Known Subclasses:

AbstractResultsSummary, ImmutableResultsSummaryImpl

public abstract class BaseResultSummary
extends BambooEntityObject
implements ImmutableResultsSummary

Base class for mutable and immutable result summaries.

Since:

v3.4

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.apache.commons.lang3.time.FastDateFormat	DATE_FORMAT

Fields inherited from interface com.atlassian.bamboo.resultsummary.ImmutableResultsSummary

CUSTOM_DATA_BUILD_KEY

Constructor Summary

Constructors

Constructor	Description
BaseResultSummary()

Method Summary

Modifier and Type	Method	Description
int	compareTo(ImmutableResultsSummary resultsSummary)
protected String	createChangeListSummary()
boolean	equals(Object object)
Collection<ArtifactLink>	getArtifactLinksThatExist()	Deprecated. since 4.3
String	getBuildTime()	When did the build start?
com.google.common.collect.ImmutableList<Commit>	getCommits()	List of commits associated with the build represented by this summary
@NotNull String	getDurationDescription()	Returns the duration in a "pretty" format.
@NotNull Set<LinkedJiraIssue>	getFixingJiraIssues()	Return JIRA issues that this build result summary fixes
Set<String>	getJiraIssueKeys()	Returns all the JIRA issue keys linked to this build result
@NotNull List<String>	getLabelNames()	A shortcut method to get all of the label names from the labellings
List<VariableSubstitution>	getManuallyOverriddenVariables()	Returns empty list for any result created by Bamboo 5.15 or later
@NotNull PlanResultKey	getPlanResultKey()	Gets the PlanResultKey for this ImmutableResultsSummary
String	getProcessingDurationDescription()	Returns the processing duration in a "pretty" format.
@NotNull Set<LinkedJiraIssue>	getRelatedJiraIssues()	Returns JIRA issues that are related to this build result.
String	getRelativeBuildDate()
String	getRelativeBuildDate(Date comparedTo)	Provides a relative build date, such as 2 hours ago.
String	getRelativeBuildStartedDate()	Returns the relative started time (duration) compared to current date
String	getRelativeBuildStartedDate(Date comparedTo)	Provides a relative build started date, such as 2 hours ago.
String	getRelativeQueueDate()
String	getRelativeQueueDate(Date comparedTo)	Provides a relative queue date, such as 2 hours ago.
String	getShortReasonSummary()
@NotNull Date	getStatDate()	When the build was executed.
@NotNull String	getTestSummary()
protected abstract TriggerManager	getTriggerManager()
Set<Author>	getUniqueAuthors()	A shortcut method to get the unique set of authors contributing to this build.
boolean	hasChanges()	Whether a build had changes or not
boolean	hasComments()	Checks if the result has any user comments for the build
int	hashCode()
boolean	isActive()	Shortcut method to see if ImmutableResultsSummary.getLifeCycleState() is LifeCycleState.PENDING or LifeCycleState.QUEUED or LifeCycleState.IN_PROGRESS
boolean	isFailed()	Shortcut method to see if ResultStatisticsProvider.getBuildState() is BuildState.FAILED
boolean	isFinalized()
boolean	isFinished()	Shortcut method to see if ImmutableResultsSummary.getLifeCycleState() is LifeCycleState.FINISHED
boolean	isInProgress()	Shortcut method to see if ImmutableResultsSummary.getLifeCycleState() is LifeCycleState.IN_PROGRESS
boolean	isNotBuilt()	Shortcut method to see if ImmutableResultsSummary.getLifeCycleState() is LifeCycleState.NOT_BUILT
boolean	isPending()	Shortcut method to see if ImmutableResultsSummary.getLifeCycleState() is LifeCycleState.PENDING
boolean	isQueued()	Shortcut method to see if ImmutableResultsSummary.getLifeCycleState() is LifeCycleState.QUEUED
boolean	isSuccessful()	Shortcut method to see if ResultStatisticsProvider.getBuildState() is BuildState.SUCCESS
boolean	isWaiting()	Shortcut method to see if ImmutableResultsSummary.getLifeCycleState() is LifeCycleState.PENDING or LifeCycleState.QUEUED

Methods inherited from class com.atlassian.core.bean.EntityObject

clone, getCreationDate, getCurrentDate, getId, getLastModificationDate, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.bamboo.core.BambooIdProvider

getId

Methods inherited from interface com.atlassian.bamboo.core.BambooObject

setId

Methods inherited from interface com.atlassian.bamboo.resultsummary.ImmutableResultsSummary

getArtifactLinks, getBuildAgentId, getBuildAgentType, getBuildCancelledDate, getBuildCompletedDate, getChangesListSummary, getCustomBuildData, getDeltaState, getDuration, getFullPlanName, getImmutableChain, getImmutablePlan, getJiraIssues, getLabellings, getLifeCycleState, getLogSize, getPlanIfExists, getPlanKey, getPlanName, getProcessingDuration, getQueueTime, getReasonSummary, getRepositoryChangesets, getRestartCount, getSubscriptions, getSubstitutedVariables, getTestResultsSummary, getTimeToFix, getTriggerReason, getVariableContextLogs, isCustomBuild, isNotRunYet, isOnceOff, isRebuild

Methods inherited from interface com.atlassian.bamboo.resultsummary.ResultStatisticsProvider

getBuildDate, getBuildNumber, getBuildState

Field Details

DATE_FORMAT

protected static final org.apache.commons.lang3.time.FastDateFormat DATE_FORMAT

Constructor Details

BaseResultSummary

public BaseResultSummary()

Method Details

isFailed

public boolean isFailed()

Description copied from interface: ImmutableResultsSummary

Shortcut method to see if ResultStatisticsProvider.getBuildState() is BuildState.FAILED

Specified by:

isFailed in interface ImmutableResultsSummary

Returns:

isSuccessful

public boolean isSuccessful()

Description copied from interface: ImmutableResultsSummary

Shortcut method to see if ResultStatisticsProvider.getBuildState() is BuildState.SUCCESS

Specified by:

isSuccessful in interface ImmutableResultsSummary

Returns:

isPending

public boolean isPending()

Description copied from interface: ImmutableResultsSummary

Shortcut method to see if ImmutableResultsSummary.getLifeCycleState() is LifeCycleState.PENDING

Specified by:

isPending in interface ImmutableResultsSummary

Returns:

isQueued

public boolean isQueued()

Description copied from interface: ImmutableResultsSummary

Shortcut method to see if ImmutableResultsSummary.getLifeCycleState() is LifeCycleState.QUEUED

Specified by:

isQueued in interface ImmutableResultsSummary

Returns:

isInProgress

public boolean isInProgress()

Description copied from interface: ImmutableResultsSummary

Shortcut method to see if ImmutableResultsSummary.getLifeCycleState() is LifeCycleState.IN_PROGRESS

Specified by:

isInProgress in interface ImmutableResultsSummary

Returns:

isNotBuilt

public boolean isNotBuilt()

Description copied from interface: ImmutableResultsSummary

Shortcut method to see if ImmutableResultsSummary.getLifeCycleState() is LifeCycleState.NOT_BUILT

Specified by:

isNotBuilt in interface ImmutableResultsSummary

Returns:

isFinalized

public boolean isFinalized()

isFinished

public boolean isFinished()

Description copied from interface: ImmutableResultsSummary

Shortcut method to see if ImmutableResultsSummary.getLifeCycleState() is LifeCycleState.FINISHED

Specified by:

isFinished in interface ImmutableResultsSummary

Returns:

isWaiting

public boolean isWaiting()

Description copied from interface: ImmutableResultsSummary

Shortcut method to see if ImmutableResultsSummary.getLifeCycleState() is LifeCycleState.PENDING or LifeCycleState.QUEUED

Specified by:

isWaiting in interface ImmutableResultsSummary

Returns:

isActive

public boolean isActive()

Description copied from interface: ImmutableResultsSummary

Shortcut method to see if ImmutableResultsSummary.getLifeCycleState() is LifeCycleState.PENDING or LifeCycleState.QUEUED or LifeCycleState.IN_PROGRESS

Specified by:

isActive in interface ImmutableResultsSummary

Returns:

getPlanResultKey

@NotNull
public @NotNull PlanResultKey getPlanResultKey()

Description copied from interface: ImmutableResultsSummary

Gets the PlanResultKey for this ImmutableResultsSummary

Specified by:

getPlanResultKey in interface ImmutableResultsSummary

Returns:

planResultKey

getDurationDescription

@NotNull
public @NotNull String getDurationDescription()

Description copied from interface: ImmutableResultsSummary

Returns the duration in a "pretty" format. Handles when duration is not known

Specified by:

getDurationDescription in interface ImmutableResultsSummary

Returns:

formatted duration

getRelativeBuildDate

public String getRelativeBuildDate()

Specified by:

getRelativeBuildDate in interface ImmutableResultsSummary

getRelativeQueueDate

public String getRelativeQueueDate()

Specified by:

getRelativeQueueDate in interface ImmutableResultsSummary

getRelativeBuildStartedDate

public String getRelativeBuildStartedDate()

Description copied from interface: ImmutableResultsSummary

Returns the relative started time (duration) compared to current date

Specified by:

getRelativeBuildStartedDate in interface ImmutableResultsSummary

Returns:

relative duration

getRelativeBuildDate

public String getRelativeBuildDate(Date comparedTo)

Provides a relative build date, such as 2 hours ago.

Specified by:

getRelativeBuildDate in interface ImmutableResultsSummary

Returns:

The relative date

getRelativeQueueDate

public String getRelativeQueueDate(Date comparedTo)

Provides a relative queue date, such as 2 hours ago.

Specified by:

getRelativeQueueDate in interface ImmutableResultsSummary

Returns:

The relative date

getRelativeBuildStartedDate

public String getRelativeBuildStartedDate(Date comparedTo)

Provides a relative build started date, such as 2 hours ago.

Specified by:

getRelativeBuildStartedDate in interface ImmutableResultsSummary

Returns:

The relative date

getShortReasonSummary

public String getShortReasonSummary()

Specified by:

getShortReasonSummary in interface ImmutableResultsSummary

getTriggerManager

protected abstract TriggerManager getTriggerManager()

getFixingJiraIssues

@NotNull
public @NotNull Set<LinkedJiraIssue> getFixingJiraIssues()

Description copied from interface: ImmutableResultsSummary

Return JIRA issues that this build result summary fixes

Specified by:

getFixingJiraIssues in interface ImmutableResultsSummary

Returns:

getRelatedJiraIssues

@NotNull
public @NotNull Set<LinkedJiraIssue> getRelatedJiraIssues()

Description copied from interface: ImmutableResultsSummary

Returns JIRA issues that are related to this build result. Does not include fixing issues

Specified by:

getRelatedJiraIssues in interface ImmutableResultsSummary

Returns:

hasChanges

public boolean hasChanges()

Description copied from interface: ImmutableResultsSummary

Whether a build had changes or not

Specified by:

hasChanges in interface ImmutableResultsSummary

Returns:

getStatDate

@NotNull
public @NotNull Date getStatDate()

Description copied from interface: ResultStatisticsProvider

When the build was executed. If build was not completed, queued time is provided instead.

Specified by:

getStatDate in interface ResultStatisticsProvider

Returns:

date of build execution or queued time if build was not executed or state is unknown

getJiraIssueKeys

public Set<String> getJiraIssueKeys()

Description copied from interface: ImmutableResultsSummary

Returns all the JIRA issue keys linked to this build result

Specified by:

getJiraIssueKeys in interface ImmutableResultsSummary

Returns:

getLabelNames

@NotNull
public @NotNull List<String> getLabelNames()

Description copied from interface: ImmutableResultsSummary

A shortcut method to get all of the label names from the labellings

Specified by:

getLabelNames in interface ImmutableResultsSummary

Returns:

getUniqueAuthors

public Set<Author> getUniqueAuthors()

Description copied from interface: ImmutableResultsSummary

A shortcut method to get the unique set of authors contributing to this build.

Specified by:

getUniqueAuthors in interface ImmutableResultsSummary

Returns:

Set of Authors

getArtifactLinksThatExist

@Deprecated
public Collection<ArtifactLink> getArtifactLinksThatExist()

Deprecated.

since 4.3

This returns live view of the getArtifactLinks()

Specified by:

getArtifactLinksThatExist in interface ImmutableResultsSummary

Returns:

getProcessingDurationDescription

public String getProcessingDurationDescription()

Description copied from interface: ImmutableResultsSummary

Returns the processing duration in a "pretty" format. Handles unknown processing duration.

Specified by:

getProcessingDurationDescription in interface ImmutableResultsSummary

Returns:

formatted processing duration

getBuildTime

public String getBuildTime()

When did the build start?

Specified by:

getBuildTime in interface ImmutableResultsSummary

Returns:

The date and time of the build.

createChangeListSummary

protected String createChangeListSummary()

getCommits

public com.google.common.collect.ImmutableList<Commit> getCommits()

Description copied from interface: ImmutableResultsSummary

List of commits associated with the build represented by this summary

Specified by:

getCommits in interface ImmutableResultsSummary

Returns:

list of commits

getTestSummary

@NotNull
public @NotNull String getTestSummary()

Specified by:

getTestSummary in interface ImmutableResultsSummary

compareTo

public int compareTo(ImmutableResultsSummary resultsSummary)

Specified by:

compareTo in interface Comparable<ImmutableResultsSummary>

equals

public boolean equals(Object object)

Overrides:

equals in class com.atlassian.core.bean.EntityObject

hashCode

public int hashCode()

Overrides:

hashCode in class com.atlassian.core.bean.EntityObject

getManuallyOverriddenVariables

public List<VariableSubstitution> getManuallyOverriddenVariables()

Description copied from interface: ImmutableResultsSummary

Returns empty list for any result created by Bamboo 5.15 or later

Specified by:

getManuallyOverriddenVariables in interface ImmutableResultsSummary

hasComments

public boolean hasComments()

Description copied from interface: ImmutableResultsSummary

Checks if the result has any user comments for the build

Specified by:

hasComments in interface ImmutableResultsSummary

Returns: