Allow the caller to wait for the mergeable state to change.

kohsuke · kohsuke · commit 4e31636181a2 · 2018-01-12T21:25:30.000-08:00
This approaches hub4j#394 differently. The problem with the original hub4j#394 is that the supposed behaviour is only useful for people waiting for `getMergeable()` to return non-null in a busy loop, yet it impacts all the other methods of this object.
diff --git a/src/main/java/org/kohsuke/github/GHPullRequest.java b/src/main/java/org/kohsuke/github/GHPullRequest.java
@@ -182,6 +182,13 @@ public boolean canMaintainerModify() throws IOException {
         return maintainer_can_modify;
     }
 
+    /**
+     * Is this PR mergeable?
+     *
+     * @return
+     *      null if the state has not been determined yet, for example when a PR is newly created.
+     *      Use {@link #refresh()} after some interval to wait until the value is determined.
+     */
     public Boolean getMergeable() throws IOException {
         populate();
         return mergeable;
@@ -217,6 +224,13 @@ public String getMergeCommitSha() throws IOException {
      */
     private void populate() throws IOException {
         if (mergeable_state!=null)    return; // already populated
+        refresh();
+    }
+
+    /**
+     * Repopulates this object.
+     */
+    public void refresh() throws IOException {
         if (root.isOffline()) {
             return; // cannot populate, will have to live with what we have
         }
