Package 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	Description
static final PlanVcsRevisionData	NULL_REVISION

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

NULL_REVISION

public static final PlanVcsRevisionData NULL_REVISION

Constructor Details

PlanVcsRevisionData

@Deprecated
public PlanVcsRevisionData(@Nullable
 @Nullable String vcsRevisionKey,
 @Nullable
 @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
 @NotNull BuildRepositoryChanges buildRepositoryChanges)

PlanVcsRevisionData

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

Method Details

getVcsRevisionKey

@Nullable
public @Nullable String getVcsRevisionKey()

getCustomXmlData

@Nullable
public @Nullable String getCustomXmlData()

getActualBranch

@Nullable
public @Nullable 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 @Nullable 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