com.atlassian.bamboo.plan.vcsRevision

Class PlanVcsRevisionData

java.lang.Object

com.atlassian.bamboo.plan.vcsRevision.PlanVcsRevisionData

@PublicApi
public class PlanVcsRevisionData
extends Object

Class representing revision data using in change detection. Data consist of: - vcsRevisionKey (null values allowed when no change detection history exists for repository; not-null otherwise) - customXmlData (optional; only used by certain repositories, e.g. SVN with externals enabled) - overriddenBranch (optional: only used by Git repository currently, custom revision build)

Field Summary

Fields

Modifier and Type	Field and Description
static PlanVcsRevisionData	NULL_REVISION

Constructor Summary

Constructors

Constructor and Description
PlanVcsRevisionData(BuildRepositoryChanges buildRepositoryChanges)
PlanVcsRevisionData(String vcsRevisionKey, String customXmlData) Deprecated. since 5.14 you should always set actual branch if it can be done
PlanVcsRevisionData(String vcsRevisionKey, String customXmlData, VcsBranch actualBranch)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
VcsBranch	getActualBranch() Vcs branch on which change actually is.
String	getCustomXmlData()
VcsBranch	getOverriddenBranch() Deprecated. since 5.14 use getActualBranch()
String	getVcsRevisionKey()
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

NULL_REVISION

public static final PlanVcsRevisionData NULL_REVISION

Constructor Detail

PlanVcsRevisionData

@Deprecated
public PlanVcsRevisionData(@Nullable
                                       String vcsRevisionKey,
                                       @Nullable
                                       String customXmlData)

Deprecated. since 5.14 you should always set actual branch if it can be done

Parameters:

vcsRevisionKey -

customXmlData -

PlanVcsRevisionData

public PlanVcsRevisionData(@NotNull
                           BuildRepositoryChanges buildRepositoryChanges)

PlanVcsRevisionData

public PlanVcsRevisionData(@Nullable
                           String vcsRevisionKey,
                           @Nullable
                           String customXmlData,
                           @Nullable
                           VcsBranch actualBranch)

Method Detail

getVcsRevisionKey

@Nullable
public String getVcsRevisionKey()

getCustomXmlData

@Nullable
public String getCustomXmlData()

getActualBranch

@Nullable
public VcsBranch getActualBranch()

Vcs branch on which change actually is. It can be different from repository's configured branch under some circumstances. Can be null if the change is NULL_REVISION object or branching is not supported.

Returns:

vcs branch or null

Since:

5.14

getOverriddenBranch

@Deprecated
 @Nullable
public VcsBranch getOverriddenBranch()

Deprecated. since 5.14 use getActualBranch()

Returns:

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object