Package com.atlassian.bamboo.plugins.github.viewer

Class GitHubVcsRepositoryViewer

java.lang.Object

com.atlassian.bamboo.plugins.github.viewer.GitHubVcsRepositoryViewer

All Implemented Interfaces:

VcsRepositoryViewer

public class GitHubVcsRepositoryViewer
extends Object
implements VcsRepositoryViewer

Constructor Summary

Constructors

Constructor	Description
GitHubVcsRepositoryViewer()

Method Summary

Modifier and Type	Method	Description
@Nullable String	getWebRepositoryUrlForFile(@NotNull CommitFile file, @NotNull VcsRepositoryData repositoryData)	Generate the link to a given file in a given repository
@Nullable String	getWebRepositoryUrlForFileDiff(@NotNull CommitFile file, @NotNull VcsRepositoryData repositoryData)	Generate the link to a given file, showing changes in given revision.
@Nullable String	getWebRepositoryUrlForFileRevision(@NotNull CommitFile file, @NotNull VcsRepositoryData repositoryData)	Generate the link to a given file in a given repository at given revision,
@Nullable String	getWebRepositoryUrlForRevision(@NotNull String revisionId, @NotNull VcsRepositoryData repositoryData)	Provide the url to link to the given revision in the web repository
@NotNull Map<String,String>	getWebRepositoryUrlForRevisions(Stream<String> revisionIds, VcsRepositoryData repositoryDefinition)	Provide the urls to link all the given commits in the web repository

Methods inherited from class java.lang.Object

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

Constructor Detail

GitHubVcsRepositoryViewer

public GitHubVcsRepositoryViewer()

Method Detail

getWebRepositoryUrlForRevision

@Nullable
public @Nullable String getWebRepositoryUrlForRevision(@NotNull
                                                       @NotNull String revisionId,
                                                       @NotNull
                                                       @NotNull VcsRepositoryData repositoryData)

Description copied from interface: VcsRepositoryViewer

Provide the url to link to the given revision in the web repository

Specified by:

getWebRepositoryUrlForRevision in interface VcsRepositoryViewer

Parameters:

revisionId - the revision to links to. Should not be blank or null.

repositoryData - the repository type the commit came from

Returns:

a full url string.

getWebRepositoryUrlForRevisions

@NotNull
public @NotNull Map<String,String> getWebRepositoryUrlForRevisions(Stream<String> revisionIds,
                                                                         VcsRepositoryData repositoryDefinition)

Description copied from interface: VcsRepositoryViewer

Provide the urls to link all the given commits in the web repository

Specified by:

getWebRepositoryUrlForRevisions in interface VcsRepositoryViewer

Parameters:

revisionIds - to generate links for. Stream should not contain empty values or nulls.

repositoryDefinition - the repository type the commit came from

Returns:

a map of the commit to its url.

getWebRepositoryUrlForFile

@Nullable
public @Nullable String getWebRepositoryUrlForFile(@NotNull
                                                   @NotNull CommitFile file,
                                                   @NotNull
                                                   @NotNull VcsRepositoryData repositoryData)

Description copied from interface: VcsRepositoryViewer

Generate the link to a given file in a given repository

Specified by:

getWebRepositoryUrlForFile in interface VcsRepositoryViewer

Parameters:

file - The file we want to link to.

repositoryData - For the build (and hense the repository file belongs to).

Returns:

The url

getWebRepositoryUrlForFileRevision

@Nullable
public @Nullable String getWebRepositoryUrlForFileRevision(@NotNull
                                                           @NotNull CommitFile file,
                                                           @NotNull
                                                           @NotNull VcsRepositoryData repositoryData)

Description copied from interface: VcsRepositoryViewer

Generate the link to a given file in a given repository at given revision,

Specified by:

getWebRepositoryUrlForFileRevision in interface VcsRepositoryViewer

Parameters:

file - The file we want to link to.

repositoryData - For the build (and hense the repository file belongs to).

Returns:

The url

getWebRepositoryUrlForFileDiff

@Nullable
public @Nullable String getWebRepositoryUrlForFileDiff(@NotNull
                                                       @NotNull CommitFile file,
                                                       @NotNull
                                                       @NotNull VcsRepositoryData repositoryData)

Description copied from interface: VcsRepositoryViewer

Generate the link to a given file, showing changes in given revision.

Specified by:

getWebRepositoryUrlForFileDiff in interface VcsRepositoryViewer

Parameters:

file - The file we want to link to.

repositoryData - For the build (and hense the repository file belongs to).

Returns:

The url