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
static String	NAME_DELIMITER

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()
Optional<Long>	getDatabaseId()
long	getId() Returns database id of the plan.
long	getMasterId() Deprecated. since 6.9 use getMasterIdIfExists() instead
Optional<Long>	getMasterIdIfExists()
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

NAME_DELIMITER

static final String NAME_DELIMITER

See Also:

Constant Field Values

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()

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

Specified by:

getId in interface BambooIdProvider

Throws:

IllegalStateException - if this plan is not a DB object.

getDatabaseId

@NotNull
Optional<Long> getDatabaseId()

Returns:

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

getMasterId

@Deprecated
long getMasterId()

Deprecated. since 6.9 use getMasterIdIfExists() instead

Returns:

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

getMasterIdIfExists

@NotNull
Optional<Long> getMasterIdIfExists()

Returns:

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

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