Package com.atlassian.bamboo.specs.builders.repository.viewer

Class GenericRepositoryViewer

java.lang.Object

com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<VcsRepositoryViewerProperties>

com.atlassian.bamboo.specs.api.builders.repository.viewer.VcsRepositoryViewer

com.atlassian.bamboo.specs.builders.repository.viewer.GenericRepositoryViewer

public class GenericRepositoryViewer
extends VcsRepositoryViewer

Represents a generic viewer.

Generic viewer is simplistic implementation of commit link generator done on the 'best effort' basis. More specialised implementations, e.g. FishEyeRepositoryViewer or BitbucketCloudRepositoryViewer should be preferred, if applicable.

Constructor Summary

Constructors

Constructor	Description
GenericRepositoryViewer()	Specifies a generic viewer.

Method Summary

Modifier and Type	Method	Description
protected @NotNull GenericRepositoryViewerProperties	build()
GenericRepositoryViewer	repositoryPath(@Nullable String repositoryPath)	Sets a relative path in remote repository.
GenericRepositoryViewer	viewerUrl(@NotNull String viewerUrl)	Sets url to be used for link generation.

Methods inherited from class java.lang.Object

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

Constructor Details

GenericRepositoryViewer

public GenericRepositoryViewer()

Specifies a generic viewer.

Method Details

viewerUrl

public GenericRepositoryViewer viewerUrl(@NotNull
 @NotNull String viewerUrl)

Sets url to be used for link generation.

repositoryPath

public GenericRepositoryViewer repositoryPath(@Nullable
 @Nullable String repositoryPath)

Sets a relative path in remote repository. By default, it is empty.

When checking out a module from a repository, for example SVN repository, a file path shown in Bamboo is relative to that module and not the repository root. If that's the case, the missing part of the path needs to be defined here.

build

@NotNull
protected @NotNull GenericRepositoryViewerProperties build()

Specified by:

build in class VcsRepositoryViewer