Package com.atlassian.bamboo.plan

Class PlanKey

java.lang.Object

com.atlassian.bamboo.plan.PlanKey

All Implemented Interfaces:

Key, Serializable, Comparable<PlanKey>

@Immutable
@PublicApi
public final class PlanKey
extends Object
implements Comparable<PlanKey>, Key

Identifier for Plan PlanKeys can be created via PlanKeys

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
int	compareTo(PlanKey planKey)
boolean	equals(Object o)
@NotNull String	getKey()	Full plan key (e.g.
@NotNull String	getPartialKey()	Partial plan key (e.g.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getKey

@NotNull
public @NotNull String getKey()

Full plan key (e.g. BAM-MAIN)

Specified by:

getKey in interface Key

Returns:

Key for the plan BAM-MAIN

getPartialKey

@NotNull
public @NotNull String getPartialKey()

Partial plan key (e.g. MAIN for BAM-MAIN)

Returns:

Partial key for the plan

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(PlanKey planKey)

Specified by:

compareTo in interface Comparable<PlanKey>

toString

public String toString()

Overrides:

toString in class Object