@Immutable public abstract class DecoratedPlan extends Object implements DecoratedNavObject, PlanIdentifier
Modifier and Type | Class and Description |
---|---|
static class |
DecoratedPlan.DecoratedBranch
Branches are top level branch plans.
|
static class |
DecoratedPlan.DecoratedPlanBranchGist |
NAME_DELIMITER
getPlanKey
Modifier and Type | Method and Description |
---|---|
com.google.common.collect.ImmutableList<DecoratedPlan.DecoratedPlanBranchGist> |
getBranches() |
abstract @Nullable String |
getBranchName() |
@Nullable String |
getBranchPlanKey()
Return the the branch plan key.
|
@NotNull String |
getBuildKey()
This objects specific portion of the key.
|
@NotNull String |
getBuildName() |
@NotNull Optional<Long> |
getDatabaseId() |
String |
getDescription() |
@NotNull String |
getDisplayName() |
long |
getId()
Returns database id of the plan.
|
@NotNull String |
getKey() |
com.google.common.collect.ImmutableList<String> |
getLabelNames() |
@Nullable String |
getLinkedJiraIssue() |
abstract @Nullable DecoratedPlan |
getMaster()
The master plan iff the plan is a branched plan and it has a master.
|
@NotNull String |
getMasterChainKey()
Return the main chain key for this plan.
|
long |
getMasterId() |
@NotNull Optional<Long> |
getMasterIdIfExists() |
@Nullable String |
getMasterJobKey()
Return the job key of this plan.
|
@NotNull String |
getName()
Returns the full name for the build in the form of "project name - build name" e.g.
|
@NotNull com.google.common.collect.ImmutableList<? extends DecoratedNavGroupObject> |
getNavGroups() |
abstract @Nullable DecoratedPlan |
getParent() |
abstract @Nullable PlanBranchWorkflow |
getPlanBranchWorkflow() |
@NotNull PlanKey |
getPlanKey()
|
@NotNull PlanType |
getPlanType() |
@NotNull ProjectIdentifier |
getProject()
Returns the parent
Project |
abstract List<DeploymentProject> |
getRelatedDeploymentProjects() |
com.google.common.collect.ImmutableList<DecoratedStage> |
getStages() |
abstract @Nullable DecoratedStage |
getStageWithName(@NotNull String stageName)
Retrieve the named stage.
|
@Nullable DecoratedNavObjectStatus |
getStatus() |
@NotNull String |
getType() |
boolean |
isRemoteJiraLinkRequired() |
boolean |
isResult() |
boolean |
isSuspendedFromBuilding()
Checks if the build has been enabled / disabled.
|
@Nullable String |
replaceKey(String url,
DecoratedNavObject originalObject)
Given an existing url (may be directly from the originalObject or may be with a static ${planKey} reference) generate
the new url for this object
|
void |
setLabels(com.google.common.collect.ImmutableList<String> labels) |
@NotNull public @NotNull String getKey()
getKey
in interface DecoratedNavObject
@NotNull public @NotNull String getBuildKey()
PlanIdentifier
PlanIdentifier.getPlanKey()
.getBuildKey
in interface PlanIdentifier
@NotNull public @NotNull String getDisplayName()
getDisplayName
in interface DecoratedNavObject
@NotNull public @NotNull com.google.common.collect.ImmutableList<? extends DecoratedNavGroupObject> getNavGroups()
getNavGroups
in interface DecoratedNavObject
@Nullable public abstract @Nullable DecoratedPlan getParent()
getParent
in interface DecoratedNavObject
@NotNull public @NotNull PlanType getPlanType()
getPlanType
in interface PlanIdentifier
getPlanType
in interface DecoratedNavObject
@Nullable public @Nullable DecoratedNavObjectStatus getStatus()
getStatus
in interface DecoratedNavObject
@Nullable public @Nullable String replaceKey(String url, DecoratedNavObject originalObject)
DecoratedNavObject
replaceKey
in interface DecoratedNavObject
url
- - to manipulateoriginalObject
- - the object the original url may have belonged to@Nullable public abstract @Nullable DecoratedPlan getMaster()
DecoratedNavObject
getMaster
in interface DecoratedNavObject
public long getId()
PlanIdentifier
PlanIdentifier.getDatabaseId()
should be preferred.getId
in interface BambooIdProvider
getId
in interface PlanIdentifier
@NotNull public @NotNull Optional<Long> getDatabaseId()
getDatabaseId
in interface PlanIdentifier
@NotNull public @NotNull PlanKey getPlanKey()
PlanIdentifier
getPlanKey
in interface PlanIdentifier
getPlanKey
in interface PlanKeyProvider
@NotNull public @NotNull String getName()
PlanIdentifier
getName
in interface PlanIdentifier
getName
in interface DescriptionProvider
getName
in interface NameProvider
@NotNull public @NotNull ProjectIdentifier getProject()
PlanIdentifier
Project
getProject
in interface PlanIdentifier
Project
. Never null@NotNull public @NotNull String getBuildName()
getBuildName
in interface PlanIdentifier
PlanIdentifier.getName()
public String getDescription()
getDescription
in interface DescriptionProvider
public long getMasterId()
getMasterId
in interface PlanIdentifier
@NotNull public @NotNull Optional<Long> getMasterIdIfExists()
getMasterIdIfExists
in interface PlanIdentifier
public com.google.common.collect.ImmutableList<String> getLabelNames()
@NotNull public @NotNull String getType()
getType
in interface DecoratedNavObject
public boolean isResult()
isResult
in interface DecoratedNavObject
public boolean isSuspendedFromBuilding()
PlanIdentifier
isSuspendedFromBuilding
in interface PlanIdentifier
public com.google.common.collect.ImmutableList<DecoratedStage> getStages()
public com.google.common.collect.ImmutableList<DecoratedPlan.DecoratedPlanBranchGist> getBranches()
public void setLabels(com.google.common.collect.ImmutableList<String> labels)
@Nullable public abstract @Nullable String getBranchName()
@Nullable public abstract @Nullable PlanBranchWorkflow getPlanBranchWorkflow()
@Nullable public @Nullable String getLinkedJiraIssue()
public boolean isRemoteJiraLinkRequired()
@NotNull public @NotNull String getMasterChainKey()
@Nullable public @Nullable String getMasterJobKey()
@Nullable public @Nullable String getBranchPlanKey()
public abstract List<DeploymentProject> getRelatedDeploymentProjects()
@Nullable public abstract @Nullable DecoratedStage getStageWithName(@NotNull @NotNull String stageName)
Copyright © 2022 Atlassian Software Systems Pty Ltd. All rights reserved.