Package com.atlassian.bamboo.plan.cache

Class AbstractImmutablePlan

java.lang.Object

com.atlassian.bamboo.plan.cache.AbstractImmutablePlan

All Implemented Interfaces:

BambooIdProvider, ImmutableEntityWithOid, ImmutableDeletable, ImmutablePlan, PlanIdentifier, PlanKeyProvider, DescriptionProvider, NameProvider, Versionable, Comparable<ImmutablePlan>

Direct Known Subclasses:

AbstractImmutableChain, ImmutableJobImpl

public abstract class AbstractImmutablePlan
extends Object
implements ImmutablePlan, Comparable<ImmutablePlan>

Field Summary

Fields

Modifier and Type	Field	Description
protected io.atlassian.util.concurrent.ResettableLazyReference<Long>	averageBuildDuration
protected BuildDefinition	buildDefinition
protected final InternalResultsSummaryAccessor	immutableResultsSummaryAccessor

Fields inherited from interface com.atlassian.bamboo.plan.cache.ImmutablePlan

MAX_PREVIOUS_BUILD_FOR_AVE, STATUS_CURRENTLY_BUILDING, STATUS_FAIL, STATUS_NO_BUILDS, STATUS_NOT_RUN, STATUS_SUCCESS

Fields inherited from interface com.atlassian.bamboo.plan.PlanIdentifier

NAME_DELIMITER

Fields inherited from interface com.atlassian.bamboo.plan.PlanKeyProvider

getPlanKey

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractImmutablePlan(@Nullable Long databaseId, @NotNull ImmutablePlan plan, @NotNull PlanKey planKey, @NotNull String name, BuildLoggerManager buildLoggerManager, @NotNull LabelDao labelDao, VariableDefinitionManager variableDefinitionManager, @NotNull BuildDefinition buildDefinition, InternalResultsSummaryAccessor immutableResultsSummaryAccessor)
	AbstractImmutablePlan(@Nullable Long databaseId, @NotNull ImmutablePlan plan, BuildLoggerManager buildLoggerManager, @NotNull LabelDao labelDao, VariableDefinitionManager variableDefinitionManager, @NotNull BuildDefinition buildDefinition, InternalResultsSummaryAccessor immutableResultsSummaryAccessor)
protected	AbstractImmutablePlan(Long id, EnrichedPlanDto dto, PlanKey planKey, String name, BuildLoggerManager buildLoggerManager, VariableDefinitionManager variableDefinitionManager, InternalResultsSummaryAccessor immutableResultsSummaryAccessor)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ImmutablePlan plan)
boolean	equals(Object o)
protected void	exceptionOnModification()
long	getAverageBuildDuration()	Returns an average duration of the recent builds
@NotNull BuildDefinition	getBuildDefinition()	Returns the BuildDefinition that backs this Plan
@NotNull String	getBuildKey()	This objects specific portion of the key.
@NotNull BuildLogger	getBuildLogger()	Returns the helper object to deal with logging
@NotNull String	getBuildName()
@NotNull String	getCurrentStatus()
@NotNull Optional<Long>	getDatabaseId()
String	getDescription()
@NotNull List<VariableDefinition>	getEffectiveVariables()	Return effective list of VariableDefinitions bind to this Plan.
int	getFirstBuildNumber()	What the number of the first build we have? It may not be 1 as some may have been removed!
long	getId()	Returns database id of the plan.
@NotNull String	getKey()	Obtain the plan's unique key (uppercase alphanumeric).
@NotNull List<Labelling>	getLabellings()
@NotNull List<String>	getLabelNames()
int	getLastBuildNumber()	What was the number of the latest build (may be being built)
long	getMasterId()
@NotNull Optional<Long>	getMasterIdIfExists()
@NotNull String	getName()	Returns the full name for the build in the form of "project name - build name" e.g.
BambooEntityOid	getOid()	OID assigned to this object.
@NotNull PlanKey	getPlanKey()	Get the PlanKey identifier for this Plan
@NotNull PlanType	getPlanType()
@NotNull Project	getProject()	Returns the parent Project
@NotNull List<Labelling>	getRelatedLabellings()
@NotNull String	getType()	Returns the string representation of the type.
@NotNull List<VariableDefinition>	getVariables()	Return list of VariableDefinitions bind to this Plan
@NotNull Long	getVersion()	Returns the version number of this object.
int	hashCode()
boolean	hasMaster()
boolean	isMarkedForDeletion()	Is the plan set to be deleted in the future
boolean	isSuspendedFromBuilding()	Checks if the build has been enabled / disabled.
abstract void	resetLatestResultsSummary(int latestKnownBuildNumber, boolean resetAverageBuildDuration)
protected void	resetLatestResultsSummary(io.atlassian.util.concurrent.ResettableLazyReference<? extends ImmutableResultsSummary> latestResultsSummary, int latestKnownBuildNumber, boolean resetAverageBuildDuration)

Methods inherited from class java.lang.Object

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

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

getEntityType

Methods inherited from interface com.atlassian.bamboo.plan.cache.ImmutablePlan

getLatestResultsSummary, getMaster, isActive, isBusy, isExecuting

Field Details

buildDefinition

protected BuildDefinition buildDefinition

immutableResultsSummaryAccessor

protected final InternalResultsSummaryAccessor immutableResultsSummaryAccessor

averageBuildDuration

protected io.atlassian.util.concurrent.ResettableLazyReference<Long> averageBuildDuration

Constructor Details

AbstractImmutablePlan

public AbstractImmutablePlan(@Nullable
 @Nullable Long databaseId,
 @NotNull
 @NotNull ImmutablePlan plan,
 BuildLoggerManager buildLoggerManager,
 @NotNull
 @NotNull LabelDao labelDao,
 VariableDefinitionManager variableDefinitionManager,
 @NotNull
 @NotNull BuildDefinition buildDefinition,
 InternalResultsSummaryAccessor immutableResultsSummaryAccessor)

AbstractImmutablePlan

protected AbstractImmutablePlan(@Nullable
 @Nullable Long databaseId,
 @NotNull
 @NotNull ImmutablePlan plan,
 @NotNull
 @NotNull PlanKey planKey,
 @NotNull
 @NotNull String name,
 BuildLoggerManager buildLoggerManager,
 @NotNull
 @NotNull LabelDao labelDao,
 VariableDefinitionManager variableDefinitionManager,
 @NotNull
 @NotNull BuildDefinition buildDefinition,
 InternalResultsSummaryAccessor immutableResultsSummaryAccessor)

AbstractImmutablePlan

protected AbstractImmutablePlan(Long id,
 EnrichedPlanDto dto,
 PlanKey planKey,
 String name,
 BuildLoggerManager buildLoggerManager,
 VariableDefinitionManager variableDefinitionManager,
 InternalResultsSummaryAccessor immutableResultsSummaryAccessor)

Method Details

getId

public long getId()

Description copied from interface: PlanIdentifier

Returns database id of the plan. Use of PlanIdentifier.getDatabaseId() should be preferred.

Specified by:

getId in interface BambooIdProvider

Specified by:

getId in interface PlanIdentifier

getDatabaseId

@NotNull
public @NotNull Optional<Long> getDatabaseId()

Specified by:

getDatabaseId in interface PlanIdentifier

Returns:

database id of the plan or empty if this plan is not a DB object.

getDescription

public String getDescription()

Specified by:

getDescription in interface DescriptionProvider

getPlanKey

@NotNull
public @NotNull PlanKey getPlanKey()

Description copied from interface: PlanIdentifier

Get the PlanKey identifier for this Plan

Specified by:

getPlanKey in interface PlanIdentifier

Specified by:

getPlanKey in interface PlanKeyProvider

Returns:

planKey

getKey

@NotNull
public @NotNull String getKey()

Description copied from interface: ImmutablePlan

Obtain the plan's unique key (uppercase alphanumeric). This includes the project prefix e.g. BAM-MAIN. Prefer PlanIdentifier.getPlanKey()

Specified by:

getKey in interface ImmutablePlan

Returns:

The full key

getBuildKey

@NotNull
public @NotNull String getBuildKey()

Description copied from interface: PlanIdentifier

This objects specific portion of the key. You probably want to use PlanIdentifier.getPlanKey().

Specified by:

getBuildKey in interface PlanIdentifier

Returns:

This objects specific portion of the key

getName

@NotNull
public @NotNull String getName()

Description copied from interface: PlanIdentifier

Returns the full name for the build in the form of "project name - build name" e.g. "Confluence - HEAD"

Specified by:

getName in interface DescriptionProvider

Specified by:

getName in interface NameProvider

Specified by:

getName in interface PlanIdentifier

Returns:

String

getBuildName

@NotNull
public @NotNull String getBuildName()

Specified by:

getBuildName in interface PlanIdentifier

Returns:

The plan specific portion of the name (without the project and/or parent's names). You probably want to use PlanIdentifier.getName()

getPlanType

@NotNull
public @NotNull PlanType getPlanType()

Specified by:

getPlanType in interface PlanIdentifier

Returns:

the type of this plan

getType

@NotNull
public @NotNull String getType()

Description copied from interface: ImmutablePlan

Returns the string representation of the type. See PlanType and used in Freemarker.

Specified by:

getType in interface ImmutablePlan

Returns:

the string representation of the type

isMarkedForDeletion

public boolean isMarkedForDeletion()

Description copied from interface: ImmutablePlan

Is the plan set to be deleted in the future

Specified by:

isMarkedForDeletion in interface ImmutableDeletable

Specified by:

isMarkedForDeletion in interface ImmutablePlan

Returns:

Whether or not the Object has been marked for deletion

hasMaster

public boolean hasMaster()

Specified by:

hasMaster in interface ImmutablePlan

Returns:

true if plan has a master plan, meaning it is a plan branch or a job present on a plan branch

getVariables

@NotNull
public @NotNull List<VariableDefinition> getVariables()

Description copied from interface: ImmutablePlan

Return list of VariableDefinitions bind to this Plan

Specified by:

getVariables in interface ImmutablePlan

Returns:

non-null list of VariableDefinition

getEffectiveVariables

@NotNull
public @NotNull List<VariableDefinition> getEffectiveVariables()

Description copied from interface: ImmutablePlan

Return effective list of VariableDefinitions bind to this Plan. For master Plans this will return the same result as ImmutablePlan.getVariables(). Non-master plans will produce the sum of: - all master's variables which keys do not appear in result of ImmutablePlan.getVariables() - result of ImmutablePlan.getVariables()

Specified by:

getEffectiveVariables in interface ImmutablePlan

Returns:

non-null list of VariableDefinition

isSuspendedFromBuilding

public boolean isSuspendedFromBuilding()

Description copied from interface: PlanIdentifier

Checks if the build has been enabled / disabled.

Specified by:

isSuspendedFromBuilding in interface PlanIdentifier

Returns:

true if plan is disabled

getFirstBuildNumber

public int getFirstBuildNumber()

Description copied from interface: ImmutablePlan

What the number of the first build we have? It may not be 1 as some may have been removed!

Specified by:

getFirstBuildNumber in interface ImmutablePlan

Returns:

The number of the first build

getLastBuildNumber

public int getLastBuildNumber()

Description copied from interface: ImmutablePlan

What was the number of the latest build (may be being built)

Specified by:

getLastBuildNumber in interface ImmutablePlan

Returns:

the build number, zero if the build has not been built

getBuildDefinition

@NotNull
public @NotNull BuildDefinition getBuildDefinition()

Description copied from interface: ImmutablePlan

Returns the BuildDefinition that backs this Plan

Specified by:

getBuildDefinition in interface ImmutablePlan

Returns:

BuildDefinition object.

getProject

@NotNull
public @NotNull Project getProject()

Description copied from interface: ImmutablePlan

Returns the parent Project

Specified by:

getProject in interface ImmutablePlan

Specified by:

getProject in interface PlanIdentifier

Returns:

Project. Never null

getAverageBuildDuration

public long getAverageBuildDuration()

Description copied from interface: ImmutablePlan

Returns an average duration of the recent builds

Specified by:

getAverageBuildDuration in interface ImmutablePlan

Returns:

The duration in milliseconds

getMasterId

public long getMasterId()

Specified by:

getMasterId in interface PlanIdentifier

Returns:

database id of master of this Plan or -1 if none.

getMasterIdIfExists

@NotNull
public @NotNull Optional<Long> getMasterIdIfExists()

Specified by:

getMasterIdIfExists in interface PlanIdentifier

Returns:

database id of master of this Plan or empty if none.

getLabellings

@NotNull
public @NotNull List<Labelling> getLabellings()

getRelatedLabellings

@NotNull
public @NotNull List<Labelling> getRelatedLabellings()

getLabelNames

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

Specified by:

getLabelNames in interface ImmutablePlan

Returns:

all the names of related labels with a namespace of :label

getCurrentStatus

@NotNull
public @NotNull String getCurrentStatus()

Specified by:

getCurrentStatus in interface ImmutablePlan

Returns:

a string key as to what the status is. Can be "success", "failure", "current", "none" or "notRun". Mainly used for UI purposes.

getOid

public BambooEntityOid getOid()

Description copied from interface: ImmutableEntityWithOid

OID assigned to this object. The BambooEntityOid.getEntityType() should be the same as this object's ImmutableEntityWithOid.getEntityType().

Specified by:

getOid in interface ImmutableEntityWithOid

getVersion

@NotNull
public @NotNull Long getVersion()

Description copied from interface: Versionable

Returns the version number of this object.

Specified by:

getVersion in interface Versionable

Returns:

the version number

resetLatestResultsSummary

@Internal
public abstract void resetLatestResultsSummary(int latestKnownBuildNumber,
 boolean resetAverageBuildDuration)

exceptionOnModification

protected void exceptionOnModification()

getBuildLogger

@NotNull
public @NotNull BuildLogger getBuildLogger()

Description copied from interface: ImmutablePlan

Returns the helper object to deal with logging

Specified by:

getBuildLogger in interface ImmutablePlan

Returns:

A BuildLogger.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

compareTo

public int compareTo(ImmutablePlan plan)

Specified by:

compareTo in interface Comparable<ImmutablePlan>

resetLatestResultsSummary

protected void resetLatestResultsSummary(io.atlassian.util.concurrent.ResettableLazyReference<? extends ImmutableResultsSummary> latestResultsSummary,
 int latestKnownBuildNumber,
 boolean resetAverageBuildDuration)