com.atlassian.bamboo.plan

Interface PlanIdentifier

All Superinterfaces:

BambooIdProvider, DescriptionProvider, NameProvider, PlanKeyProvider

All Known Subinterfaces:

Buildable, Chain, ChainBranch, ChainBranchIdentifier, ImmutableBuildable, ImmutableChain, ImmutableChainBranch, ImmutableJob, ImmutablePlan, ImmutableTopLevelPlan, Job, Plan, TopLevelPlan

All Known Implementing Classes:

AbstractChain, AbstractImmutableChain, AbstractImmutablePlan, AbstractPlan, ChainBranchIdentifierImpl, ChainBranchImpl, DecoratedPlan, DecoratedPlan.DecoratedBranch, DefaultChain, DefaultJob, ImmutableChainBranchImpl, ImmutableChainImpl, ImmutableJobImpl, PlanIdentifierImpl

public interface PlanIdentifier
extends BambooIdProvider, DescriptionProvider, PlanKeyProvider

Represents the minimal information about a Plan

Since:

v4.0

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Function<PlanIdentifier,PlanKey>	getPlanKeyFunction Deprecated. since 5.10 use PlanIdentifier::getPlanKey

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

getPlanKey

Method Summary

Modifier and Type	Method and Description
String	getBuildKey() This objects specific portion of the key.
String	getBuildName()
long	getId()
long	getMasterId() Database id of master of this ChainBranch
String	getName() Returns the full name for the build in the form of "project name - build name" e.g.
PlanKey	getPlanKey() Get the PlanKey identifier for this Plan
PlanType	getPlanType()
ProjectIdentifier	getProject() Returns the parent Project
boolean	isSuspendedFromBuilding() Checks if the build has been enabled / disabled.

Methods inherited from interface com.atlassian.bamboo.utils.DescriptionProvider

getDescription

Field Detail

getPlanKeyFunction

@Deprecated
static final com.google.common.base.Function<PlanIdentifier,PlanKey> getPlanKeyFunction

Deprecated. since 5.10 use PlanIdentifier::getPlanKey

Function to extract PlanKey from PlanIdentifier

Method Detail

getId

long getId()

Specified by:

getId in interface BambooIdProvider

Returns:

Database id of the plan

getPlanType

@NotNull
PlanType getPlanType()

Returns:

the type of this plan

getPlanKey

@NotNull
PlanKey getPlanKey()

Get the PlanKey identifier for this Plan

Specified by:

getPlanKey in interface PlanKeyProvider

Returns:

planKey

getBuildKey

@NotNull
String getBuildKey()

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

Returns:

This objects specific portion of the key

getName

@NotNull
String getName()

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

Returns:

String

getBuildName

@NotNull
String getBuildName()

Returns:

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

isSuspendedFromBuilding

boolean isSuspendedFromBuilding()

Checks if the build has been enabled / disabled.

Returns:

true if plan is disabled

getProject

@NotNull
ProjectIdentifier getProject()

Returns the parent Project

Returns:

Project. Never null

getMasterId

long getMasterId()

Database id of master of this ChainBranch

Returns: