Package com.atlassian.bamboo.vcs.configuration

Interface VcsRepositoryData

All Superinterfaces:

BambooIdProvider, DescriptionProvider, ImmutableEntityWithOid, NameProvider, PluginKeyProvider, ProjectIdProvider, Serializable, Versionable

All Known Subinterfaces:

PlanRepositoryDefinition

All Known Implementing Classes:

CompleteVcsRepositoryData, MockVcsRepositoryData, PlanRepositoryDefinitionImpl, VcsRepositoryDataImpl

public interface VcsRepositoryData
extends BambooIdProvider, DescriptionProvider, Serializable, ImmutableEntityWithOid, PluginKeyProvider, ProjectIdProvider, Versionable

Effective repository definition as seen outside any specific Plan's context Product of: - importing parent's configuration - applying local configuration overrides (e.g. branch) Analogue of existing RepositoryData

Since:

5.14

Method Summary

Modifier and Type	Method	Description
@NotNull RepositoryData	asLegacyData()	Deprecated. since 5.14 for backward compatibility only
@Nullable VcsBambooSpecsDetectionOptions	getBambooSpecsDetectionOptions()
@Nullable VcsBranchDefinition	getBranch()
default BambooEntityType	getEntityType()	Entity type of this object, used in BambooEntityOid.
@Nullable Long	getParentId()	Get id of the repository this inherits data from or null if none.
@Nullable BambooEntityOid	getParentOid()	Get oid of the repository this inherits data from or null if none.
@Nullable Long	getProjectId()
long	getRootVcsRepositoryId()	Get id of the repository that is the root of the hierarchy this repository belongs to.
@Nullable VcsBranchDetectionOptions	getVcsBranchDetectionOptions()
@Nullable VcsChangeDetectionOptions	getVcsChangeDetectionOptions()
@NotNull VcsLocationDefinition	getVcsLocation()
@Nullable VcsRepositoryViewerDefinition	getViewerConfiguration()
boolean	isLegacyRepository()	Deprecated. since 5.14 for backward compatibility only
boolean	isLinked()
boolean	isMarkedForDeletion()
boolean	isRootVcsLinked()
boolean	isRootVcsProject()
boolean	isRootVcsShared()
boolean	isShared()

Methods inherited from interface com.atlassian.bamboo.core.BambooIdProvider

getId

Methods inherited from interface com.atlassian.bamboo.utils.DescriptionProvider

getDescription, getName

Methods inherited from interface com.atlassian.bamboo.core.ImmutableEntityWithOid

getOid

Methods inherited from interface com.atlassian.bamboo.plugin.PluginKeyProvider

getPluginKey

Methods inherited from interface com.atlassian.bamboo.versioning.Versionable

getVersion

Method Detail

getVcsLocation

@NotNull
@NotNull VcsLocationDefinition getVcsLocation()

getBranch

@Nullable
@Nullable VcsBranchDefinition getBranch()

getVcsChangeDetectionOptions

@Nullable
@Nullable VcsChangeDetectionOptions getVcsChangeDetectionOptions()

getVcsBranchDetectionOptions

@Nullable
@Nullable VcsBranchDetectionOptions getVcsBranchDetectionOptions()

getViewerConfiguration

@Nullable
@Nullable VcsRepositoryViewerDefinition getViewerConfiguration()

getBambooSpecsDetectionOptions

@Nullable
@Nullable VcsBambooSpecsDetectionOptions getBambooSpecsDetectionOptions()

isMarkedForDeletion

boolean isMarkedForDeletion()

isLinked

boolean isLinked()

Returns:

true iff this repository is a linked repository

isShared

boolean isShared()

Returns:

true iff this repository is a linked repository or a project repository

Since:

8.0

isLegacyRepository

@Deprecated
boolean isLegacyRepository()

Deprecated.

since 5.14 for backward compatibility only

Returns:

true if underlying repository is implemented with old API

asLegacyData

@Deprecated
@NotNull
@NotNull RepositoryData asLegacyData()

Deprecated.

since 5.14 for backward compatibility only

Returns:

this object in old format.

getEntityType

default BambooEntityType getEntityType()

Description copied from interface: ImmutableEntityWithOid

Entity type of this object, used in BambooEntityOid.

Specified by:

getEntityType in interface ImmutableEntityWithOid

getParentId

@Nullable
@Nullable Long getParentId()

Get id of the repository this inherits data from or null if none.

getParentOid

@Nullable
@Nullable BambooEntityOid getParentOid()

Get oid of the repository this inherits data from or null if none.

Since:

6.0

isRootVcsLinked

boolean isRootVcsLinked()

Returns:

true if this repository is a linked repository or inherits data (possibly indirectly) from a linked repository

isRootVcsProject

boolean isRootVcsProject()

Returns:

true if this repository is a project repository or inherits data (possibly indirectly) from a project repository

isRootVcsShared

boolean isRootVcsShared()

Returns:

true if this repository is either linked or project repository or inherits data (possibly indirectly) from a shared repository

getRootVcsRepositoryId

long getRootVcsRepositoryId()

Get id of the repository that is the root of the hierarchy this repository belongs to. Returns repository id if this repository is the root. If isRootVcsLinked() returns true, this method returns id of that linked repository.

getProjectId

@Nullable
@Nullable Long getProjectId()

Specified by:

getProjectId in interface ProjectIdProvider

Returns:

id of project which is associated with this repository, returns null if repository is global.