com.atlassian.bamboo.plan
Class PlanIdentifierImpl

java.lang.Object
  extended by com.atlassian.bamboo.plan.PlanIdentifierImpl
All Implemented Interfaces:
BambooIdProvider, PlanIdentifier, DescriptionProvider, NameProvider
Direct Known Subclasses:
ChainBranchIdentifierImpl

public class PlanIdentifierImpl
extends java.lang.Object
implements PlanIdentifier


Constructor Summary
PlanIdentifierImpl(long id, java.lang.String discriminator, PlanKey planKey, java.lang.String description, java.lang.String buildName, java.lang.String buildKey, boolean suspendedFromBuilding, java.lang.String projectKey, java.lang.String projectName, java.lang.String projectDescription, java.lang.Long masterId)
           
PlanIdentifierImpl(PlanIdentifier plan)
           
 
Method Summary
 java.lang.String getBuildKey()
          This objects specific portion of the key.
 java.lang.String getBuildName()
           
 java.lang.String getDescription()
           
 long getId()
           
 long getMasterId()
          Database id of master of this ChainBranch
 java.lang.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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PlanIdentifierImpl

public PlanIdentifierImpl(long id,
                          java.lang.String discriminator,
                          PlanKey planKey,
                          java.lang.String description,
                          java.lang.String buildName,
                          java.lang.String buildKey,
                          boolean suspendedFromBuilding,
                          java.lang.String projectKey,
                          java.lang.String projectName,
                          java.lang.String projectDescription,
                          java.lang.Long masterId)

PlanIdentifierImpl

public PlanIdentifierImpl(PlanIdentifier plan)
Method Detail

getId

public long getId()
Specified by:
getId in interface BambooIdProvider
Specified by:
getId in interface PlanIdentifier
Returns:
Database id of the plan

getPlanType

@NotNull
public PlanType getPlanType()
Specified by:
getPlanType in interface PlanIdentifier
Returns:
the type of this plan

getPlanKey

@NotNull
public PlanKey getPlanKey()
Description copied from interface: PlanIdentifier
Get the PlanKey identifier for this Plan

Specified by:
getPlanKey in interface PlanIdentifier
Returns:
planKey

getBuildKey

@NotNull
public java.lang.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 java.lang.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 PlanIdentifier
Specified by:
getName in interface DescriptionProvider
Specified by:
getName in interface NameProvider
Returns:
String

getBuildName

@NotNull
public java.lang.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()

getDescription

public java.lang.String getDescription()
Specified by:
getDescription in interface DescriptionProvider

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

getMasterId

public long getMasterId()
Description copied from interface: PlanIdentifier
Database id of master of this ChainBranch

Specified by:
getMasterId in interface PlanIdentifier
Returns:

getProject

@NotNull
public ProjectIdentifier getProject()
Description copied from interface: PlanIdentifier
Returns the parent Project

Specified by:
getProject in interface PlanIdentifier
Returns:
Project. Never null


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.