Interface PullRequestMergeability

All Superinterfaces:
PropertySupport

public interface PullRequestMergeability extends PropertySupport
Describes whether a pull request can merge and why this is so.
  • Method Details

    • canMerge

      boolean canMerge()
      Returns:
      false if the pull request cannot be merged for any reason; otherwise true
    • getOutcome

      @Nonnull PullRequestMergeOutcome getOutcome()
      Returns:
      the outcome of trying to merge this pull request
      Since:
      4.10
    • getVetoes

      @Nonnull Collection<PullRequestMergeVeto> getVetoes()
      Returns:
      a collection containing zero or more vetoes from RepositoryMergeChecks used to validate merge preconditions
    • isConflicted

      boolean isConflicted()
      Returns:
      true if the outcome is PullRequestMergeOutcome.CONFLICTED; false otherwise