Package com.atlassian.bitbucket.pull

Interface PullRequestMergeabilityPropertyProvider

public interface PullRequestMergeabilityPropertyProvider
Provides properties to PullRequestMergeability.

NOTE: Property values must be convertible to JSON (e.g. extend from RestMapEntity), or otherwise REST requests to entities owning the properties will fail.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,Object>
    provideProperties(com.atlassian.bitbucket.pull.PullRequest pullRequest, com.atlassian.bitbucket.pull.PullRequestMergeability mergeability)
    Provide properties for the provided pull request and mergeability.

  • Method Details

    • provideProperties

      @Nonnull Map<String,Object> provideProperties(@Nonnull com.atlassian.bitbucket.pull.PullRequest pullRequest, @Nonnull com.atlassian.bitbucket.pull.PullRequestMergeability mergeability)
      Provide properties for the provided pull request and mergeability. Plugins should prefix property keys with a unique identifier (e.g. the plugin key) to avoid conflicts.
      Parameters:
      pullRequest - the pull request
      mergeability - the pull request mergeability
      Returns:
      a Map of properties to be added to mergeability. Can be empty, but not null.