com.atlassian.bamboo.plan
Class PlanKeys

java.lang.Object
  extended by com.atlassian.bamboo.plan.PlanKeys

public final class PlanKeys
extends java.lang.Object

Method for producing PlanKeys and PlanResultKeys from a String


Field Summary
static com.google.common.base.Function<PlanKey,PlanKey> CHAIN_KEY_FROM_JOB_KEY
           
static com.google.common.base.Function<PlanKey,java.lang.String> PARTIAL_JOB_KEY_FROM_JOB_KEY
           
static java.util.Comparator<PlanKey> PLAN_KEY_COMPARATOR
           
static com.google.common.base.Function<java.lang.String,PlanKey> PLAN_KEY_FROM_STRING
           
static char SEP
           
static com.google.common.base.Function<PlanKey,java.lang.String> SHORT_KEY_FROM_PLAN_KEY
           
 
Method Summary
static void assertSafeKey(java.lang.String key)
           
static PlanKey getChainKeyFromJobKey(PlanKey jobKey)
          Extracts a Chain key from a jobKey and creates new PlanKey For example, BAM-REL-UNIT becomes BAM-REL
static PlanKey getChainKeyIfJobKey(PlanKey jobKey)
          Extracts a Chain key from a jobKey and creates new PlanKey For example, BAM-REL-UNIT becomes BAM-REL Returns a Chain key if the passed in key is a Job key, otherwise a null is returned
static PlanResultKey getChainResultKey(PlanResultKey planResultKey)
          Creates a chain result key from job result key.
static PlanKey getJobKey(PlanKey chainPlanKey, java.lang.String jobKey)
          Joins the a Chain key and a jobKey part to create a Job PlanKey For example, BAM-REL and UNIT becomes BAM-REL-UNIT
static java.lang.String getPartialJobKey(PlanKey jobKey)
          Return a partial job key from a full job key, e.g.
static PlanKey getPlanKey(java.lang.String planKey)
          Creates a PlanKey from its string form 'BAM-BOO' or from the result key form 'BAM-BOO-123'
static PlanKey getPlanKey(java.lang.String projectKey, java.lang.String buildKey)
          Creates a PlanKey from project key and build key
static PlanKey getPlanKey(java.lang.String projectKey, java.lang.String chainKey, java.lang.String buildKey)
          Creates a PlanKey from project key, parent chain key and build key
static java.lang.String getPlanKeyPart(PlanKey planKey)
          Returns plan key part for given PlanKey
static java.lang.String getPlanKeyPart(PlanResultKey planResultKey)
          Returns plan key part for given PlanResultKey
static PlanResultKey getPlanResultKey(PlanKey planKey, int buildNumber)
          Creates a PlanResultKey from the given PlanKey and buildNumber
static PlanResultKey getPlanResultKey(java.lang.String planResultKey)
          Creates a PlanResultKey from its string form 'BAM-BOO-123'
static PlanResultKey getPlanResultKey(java.lang.String planKey, int buildNumber)
          Creates a PlanResultKey from the given planKey and buildNumber
static java.lang.String getProjectKeyPart(PlanKey planKey)
          Returns project key part for given PlanKey
static java.lang.String getProjectKeyPart(PlanResultKey planResultKey)
          Returns project key part for given PlanResultKey
static java.lang.String getShortKeyFromPlanKey(PlanKey planKey)
          Return a last part of the plan key, e.g PROJ-CHAIN would reduce CHAIN and PROJ-CHAIN-HOB would return JOB
static boolean isJobKey(PlanKey planKey)
          Checks if PlanKey represents a Job
static com.google.common.base.Function<ImmutablePlan,PlanKey> planKeyFromPlan()
           
static com.google.common.base.Function<PlanKey,java.lang.String> planKeyToString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SEP

public static final char SEP
See Also:
Constant Field Values

PLAN_KEY_FROM_STRING

public static final com.google.common.base.Function<java.lang.String,PlanKey> PLAN_KEY_FROM_STRING

CHAIN_KEY_FROM_JOB_KEY

public static final com.google.common.base.Function<PlanKey,PlanKey> CHAIN_KEY_FROM_JOB_KEY

PARTIAL_JOB_KEY_FROM_JOB_KEY

public static final com.google.common.base.Function<PlanKey,java.lang.String> PARTIAL_JOB_KEY_FROM_JOB_KEY

PLAN_KEY_COMPARATOR

public static final java.util.Comparator<PlanKey> PLAN_KEY_COMPARATOR

SHORT_KEY_FROM_PLAN_KEY

public static final com.google.common.base.Function<PlanKey,java.lang.String> SHORT_KEY_FROM_PLAN_KEY
Method Detail

planKeyToString

public static com.google.common.base.Function<PlanKey,java.lang.String> planKeyToString()

planKeyFromPlan

public static com.google.common.base.Function<ImmutablePlan,PlanKey> planKeyFromPlan()

isJobKey

public static boolean isJobKey(@NotNull
                               PlanKey planKey)
Checks if PlanKey represents a Job

Parameters:
planKey -
Returns:
isJobKey

getPlanKey

public static PlanKey getPlanKey(@NotNull
                                 java.lang.String projectKey,
                                 @NotNull
                                 java.lang.String buildKey)
Creates a PlanKey from project key and build key

Parameters:
projectKey -
buildKey -
Returns:
key

getProjectKeyPart

@Nullable
public static java.lang.String getProjectKeyPart(@NotNull
                                                          PlanKey planKey)
Returns project key part for given PlanKey

Parameters:
planKey -
Returns:
project key

getProjectKeyPart

@Nullable
public static java.lang.String getProjectKeyPart(@NotNull
                                                          PlanResultKey planResultKey)
Returns project key part for given PlanResultKey

Parameters:
planResultKey -
Returns:
project key

getPlanKeyPart

@Nullable
public static java.lang.String getPlanKeyPart(@NotNull
                                                       PlanKey planKey)
Returns plan key part for given PlanKey

Parameters:
planKey -
Returns:
project key

getPlanKeyPart

@Nullable
public static java.lang.String getPlanKeyPart(@NotNull
                                                       PlanResultKey planResultKey)
Returns plan key part for given PlanResultKey

Parameters:
planResultKey -
Returns:
project key

getJobKey

@NotNull
public static PlanKey getJobKey(@NotNull
                                        PlanKey chainPlanKey,
                                        @NotNull
                                        java.lang.String jobKey)
Joins the a Chain key and a jobKey part to create a Job PlanKey For example, BAM-REL and UNIT becomes BAM-REL-UNIT

Parameters:
chainPlanKey -
jobKey -
Returns:
planKey

getChainKeyFromJobKey

@NotNull
public static PlanKey getChainKeyFromJobKey(@NotNull
                                                    PlanKey jobKey)
Extracts a Chain key from a jobKey and creates new PlanKey For example, BAM-REL-UNIT becomes BAM-REL

Parameters:
jobKey -
Returns:
chainKey
Throws:
java.lang.IllegalArgumentException - if the argument has incorrect format.

getChainKeyIfJobKey

@Nullable
public static PlanKey getChainKeyIfJobKey(@NotNull
                                                   PlanKey jobKey)
Extracts a Chain key from a jobKey and creates new PlanKey For example, BAM-REL-UNIT becomes BAM-REL Returns a Chain key if the passed in key is a Job key, otherwise a null is returned

Parameters:
jobKey -
Returns:
chainKey

getPlanKey

public static PlanKey getPlanKey(@NotNull
                                 java.lang.String projectKey,
                                 @Nullable
                                 java.lang.String chainKey,
                                 @NotNull
                                 java.lang.String buildKey)
Creates a PlanKey from project key, parent chain key and build key

Parameters:
projectKey -
chainKey - - if empty a key for top level plan is created
buildKey -
Returns:
key

getPlanKey

@NotNull
public static PlanKey getPlanKey(@NotNull
                                         java.lang.String planKey)
Creates a PlanKey from its string form 'BAM-BOO' or from the result key form 'BAM-BOO-123'

Parameters:
planKey -
Returns:
key
Throws:
java.lang.IllegalArgumentException - if key could not be parsed

getPlanResultKey

public static PlanResultKey getPlanResultKey(java.lang.String planResultKey)
Creates a PlanResultKey from its string form 'BAM-BOO-123'

Parameters:
planResultKey -
Returns:
key
Throws:
java.lang.IllegalArgumentException - if key could not be parsed

getPlanResultKey

public static PlanResultKey getPlanResultKey(@NotNull
                                             java.lang.String planKey,
                                             int buildNumber)
Creates a PlanResultKey from the given planKey and buildNumber

Parameters:
planKey -
buildNumber -
Returns:
key
Throws:
java.lang.IllegalArgumentException - if key could not be parsed

getPlanResultKey

public static PlanResultKey getPlanResultKey(PlanKey planKey,
                                             int buildNumber)
Creates a PlanResultKey from the given PlanKey and buildNumber

Parameters:
planKey -
buildNumber -
Returns:
planResultKey

getChainResultKey

@NotNull
public static PlanResultKey getChainResultKey(@NotNull
                                                      PlanResultKey planResultKey)
Creates a chain result key from job result key. E.g. BAM-BOO-N-1 will return BAM-BOO-1

Parameters:
planResultKey - the job result key to convert
Returns:
chain result key

getPartialJobKey

public static java.lang.String getPartialJobKey(PlanKey jobKey)
Return a partial job key from a full job key, e.g. PROJ-CHAIN-JOB would return JOB.

Parameters:
jobKey - a full job key
Returns:
partial job key

getShortKeyFromPlanKey

public static java.lang.String getShortKeyFromPlanKey(PlanKey planKey)
Return a last part of the plan key, e.g PROJ-CHAIN would reduce CHAIN and PROJ-CHAIN-HOB would return JOB

Parameters:
planKey - a full plan key
Returns:
short plan key

assertSafeKey

public static void assertSafeKey(java.lang.String key)


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