|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WebRepositoryViewer
Module that decorates change information with required stuff for web repository browsing (e.g linking files)
If you would like web repository links to be provided within you html notifications, also implement CommitUrlProvider
Field Summary | |
---|---|
static java.lang.String |
SELECTED_WEB_REPOSITORY_VIEWER
Constant for fetching out the selected web repository viewer key from a BuildConfiguration |
static java.lang.String |
WEB_REPOSITORY
|
Method Summary | |
---|---|
java.lang.String |
getHtmlForCommitsFull(ResultsSummary resultsSummary,
RepositoryChangeset repositoryChangeset,
RepositoryData repositoryData)
Renders the html to display the full commits on the changes tab. |
java.lang.String |
getHtmlForCommitsFull(ResultsSummary resultsSummary,
RepositoryChangeset repositoryChangeset,
RepositoryDefinition repositoryData)
Deprecated. since 4.0 use getHtmlForCommitsFull(ResultsSummary, RepositoryChangeset, RepositoryData) |
java.lang.String |
getHtmlForCommitsSummary(ResultsSummary resultsSummary,
RepositoryChangeset repositoryChangeset,
RepositoryData repositoryData,
int maxChanges)
Renders the html to display a summary of the commits on the Build Results Summary tab. |
java.lang.String |
getHtmlForCommitsSummary(ResultsSummary resultsSummary,
RepositoryChangeset repositoryChangeset,
RepositoryDefinition repositoryDefinition)
Deprecated. since 3.4 use getHtmlForCommitsSummary(ResultsSummary, RepositoryChangeset, RepositoryData, int) |
java.lang.String |
getHtmlForCommitsSummary(ResultsSummary resultsSummary,
RepositoryChangeset repositoryChangeset,
RepositoryDefinition repositoryData,
int maxChanges)
Deprecated. since 4.0 use getHtmlForCommitsSummary(ResultsSummary, RepositoryChangeset, RepositoryData, int) |
java.lang.String |
getKey()
The full complete plugin key for the repository viewer |
java.lang.String |
getName()
The name of the web repository viewer, as displayed in the UI. |
java.lang.String |
getShortKey()
The shorter version fo the plugin key (without prefix & should not contain any ':') |
java.util.Collection<java.lang.String> |
getSupportedRepositories()
The keys for the Repository classes that the web viewer currently supports. |
void |
populateFromParams(ActionParametersMap params)
takes the map of config data from action and extracts the parameters it needs |
Methods inherited from interface com.atlassian.bamboo.v2.build.ConfigurablePlugin |
---|
customizeBuildRequirements, removeBuildRequirements |
Methods inherited from interface com.atlassian.bamboo.v2.build.BuildConfigurationAwarePlugin |
---|
addDefaultValues, prepareConfigObject, validate |
Methods inherited from interface com.atlassian.bamboo.plugin.InitablePluginModule |
---|
init |
Methods inherited from interface com.atlassian.bamboo.v2.build.RenderableBuildConfiguration |
---|
getEditHtml, getViewHtml |
Methods inherited from interface com.atlassian.bamboo.fieldvalue.ConvertibleFromConfig |
---|
populateFromConfig, toConfiguration |
Field Detail |
---|
static final java.lang.String SELECTED_WEB_REPOSITORY_VIEWER
BuildConfiguration
static final java.lang.String WEB_REPOSITORY
Method Detail |
---|
@NotNull java.lang.String getKey()
@NotNull java.lang.String getShortKey()
@NotNull java.lang.String getName()
@NotNull java.util.Collection<java.lang.String> getSupportedRepositories()
Repository
classes that the web viewer currently supports.
If list is empty or null it assumes support for all repositories.
java.lang.String getHtmlForCommitsFull(@NotNull ResultsSummary resultsSummary, @NotNull RepositoryChangeset repositoryChangeset, @NotNull RepositoryData repositoryData)
resultsSummary
- the summary to show commits forrepositoryData
- the commits belong to aka the plans repository
java.lang.String getHtmlForCommitsSummary(@NotNull ResultsSummary resultsSummary, @NotNull RepositoryChangeset repositoryChangeset, @NotNull RepositoryData repositoryData, int maxChanges)
resultsSummary
- the summary to show commits forrepositoryData
- the commits belong to aka the plans repositorymaxChanges
- maximum number of commits to be shown. Negative value means that all commits should be shown.
@Deprecated java.lang.String getHtmlForCommitsSummary(@NotNull ResultsSummary resultsSummary, @NotNull RepositoryChangeset repositoryChangeset, @NotNull RepositoryDefinition repositoryDefinition)
getHtmlForCommitsSummary(ResultsSummary, RepositoryChangeset, RepositoryData, int)
resultsSummary
- the summary to show commits forrepositoryData
- the commits belong to aka the plans repository
@Deprecated java.lang.String getHtmlForCommitsFull(@NotNull ResultsSummary resultsSummary, @NotNull RepositoryChangeset repositoryChangeset, @NotNull RepositoryDefinition repositoryData)
getHtmlForCommitsFull(ResultsSummary, RepositoryChangeset, RepositoryData)
resultsSummary
- the summary to show commits forrepositoryData
- the commits belong to aka the plans repository
@Deprecated java.lang.String getHtmlForCommitsSummary(@NotNull ResultsSummary resultsSummary, @NotNull RepositoryChangeset repositoryChangeset, @NotNull RepositoryDefinition repositoryData, int maxChanges)
getHtmlForCommitsSummary(ResultsSummary, RepositoryChangeset, RepositoryData, int)
resultsSummary
- the summary to show commits forrepositoryData
- the commits belong to aka the plans repositorymaxChanges
- maximum number of commits to be shown. Negative value means that all commits should be shown.
void populateFromParams(@NotNull ActionParametersMap params)
params
- map of key (String), value (String []) pairs from action
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |