com.atlassian.bamboo.ww2.beans
Class DecoratedPlan

java.lang.Object
  com.atlassian.bamboo.ww2.beans.DecoratedPlan

All Implemented Interfaces:

DecoratedNavObject

@Immutable
public class DecoratedPlan
extends java.lang.Object
implements DecoratedNavObject

Method Summary

static DecoratedPlan	decoratePlan(Plan plan)
java.lang.String	getBuildName()
java.lang.String	getDescription()
java.lang.String	getDisplayName()
java.lang.String	getKey()
java.lang.String	getName()
com.google.common.collect.ImmutableList<? extends DecoratedNavGroupObject>	getNavGroups()
DecoratedPlan	getParent()
PlanKey	getPlanKey()
PlanType	getPlanType()
DecoratedProject	getProject()
com.google.common.collect.ImmutableList<DecoratedStage>	getStages()
DecoratedNavObjectStatus	getStatus()
java.lang.String	getType()
boolean	isResult()
boolean	isSuspendedFromBuilding()
java.lang.String	replaceKey(java.lang.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

Methods inherited from class java.lang.Object

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

Method Detail

decoratePlan

@Nullable
public static DecoratedPlan decoratePlan(@NotNull
                                                  Plan plan)

getKey

@NotNull
public java.lang.String getKey()

Specified by:

getKey in interface DecoratedNavObject

Returns:

full key of the object

getDisplayName

@NotNull
public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface DecoratedNavObject

Returns:

display name of this object

getNavGroups

@NotNull
public com.google.common.collect.ImmutableList<? extends DecoratedNavGroupObject> getNavGroups()

Specified by:

getNavGroups in interface DecoratedNavObject

Returns:

any children groups of this object

getParent

@Nullable
public DecoratedPlan getParent()

Specified by:

getParent in interface DecoratedNavObject

Returns:

the parent of this object (does not take into account groups)

getPlanType

@NotNull
public PlanType getPlanType()

Specified by:

getPlanType in interface DecoratedNavObject

Returns:

plantype associated with this object.

getStatus

@Nullable
public DecoratedNavObjectStatus getStatus()

Specified by:

getStatus in interface DecoratedNavObject

Returns:

provide the status of this object if applicable

replaceKey

@Nullable
public java.lang.String replaceKey(java.lang.String url,
                                            DecoratedNavObject originalObject)

Description copied from interface: DecoratedNavObject

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

Specified by:

replaceKey in interface DecoratedNavObject

Parameters:

url - - to manipulate

originalObject - - the object the original url may have belonged to

Returns:

the new url referencing this object

getPlanKey

public PlanKey getPlanKey()

getName

public java.lang.String getName()

getProject

public DecoratedProject getProject()

getBuildName

public java.lang.String getBuildName()

getDescription

public java.lang.String getDescription()

getType

@NotNull
public java.lang.String getType()

Specified by:

getType in interface DecoratedNavObject

Returns:

plantype associated with this object.

isResult

public boolean isResult()

Specified by:

isResult in interface DecoratedNavObject

Returns:

true if the nav object represents a result otherwise false

isSuspendedFromBuilding

public boolean isSuspendedFromBuilding()

getStages

public com.google.common.collect.ImmutableList<DecoratedStage> getStages()