Package com.atlassian.bitbucket.pull

Interface PullRequestCommitEnricher

public interface PullRequestCommitEnricher

Since:

4.8

Method Summary

Modifier and Type	Method	Description
Commit	enrich(PullRequest pullRequest, Commit commit, Collection<String> propertyKeys)	Enrich a single commit with properties from the CommitIndex.
Page<Commit>	enrichPage(PullRequest pullRequest, Page<Commit> page, Collection<String> propertyKeys)	Enrich a page of commits with properties from the CommitIndex.

Method Details

enrich

@Nonnull
Commit enrich(@Nonnull
 PullRequest pullRequest,
 @Nonnull
 Commit commit,
 @Nullable
 Collection<String> propertyKeys)

Enrich a single commit with properties from the CommitIndex.

Parameters:

pullRequest - the pull request the commit was retrieved from

commit - the commit to enrich

propertyKeys - keys for CommitIndex properties to load

Returns:

the enriched commit

enrichPage

@Nonnull
Page<Commit> enrichPage(@Nonnull
 PullRequest pullRequest,
 @Nonnull
 Page<Commit> page,
 @Nullable
 Collection<String> propertyKeys)

Enrich a page of commits with properties from the CommitIndex.

Parameters:

pullRequest - the pull request the commits were retrieved from

page - the page of commits to enrich

propertyKeys - keys for CommitIndex properties to load

Returns:

a page of enriched commits