review

Author: pvillard31

src/main/java/org/kohsuke/github/GitHubBuilder.java

@@ -211,6 +211,33 @@ public GitHubBuilder clone() {
         }
     }
 
+    /**
+     * Configures the client to use Jackson 3.x for JSON serialization/deserialization.
+     *
+     * <p>
+     * By default, Jackson 2.x is used. Call this method to use Jackson 3.x instead.
+     * </p>
+     *
+     * <h3>Example</h3>
+     *
+     * <pre>
+     * GitHub github = new GitHubBuilder().withOAuthToken("token").useJackson3().build();
+     * </pre>
+     *
+     * <p>
+     * <strong>Note:</strong> To use Jackson 3.x, you must add the Jackson 3 {@code tools.jackson.core:jackson-databind}
+     * dependency to your project.
+     * </p>
+     *
+     * @return the GitHubBuilder
+     * @throws IllegalStateException
+     *             if Jackson 3.x is not available on the classpath
+     */
+    public GitHubBuilder useJackson3() {
+        this.jackson = DefaultGitHubJackson.createJackson3();
+        return this;
+    }
+
     /**
      * Adds a {@link GitHubAbuseLimitHandler} to this {@link GitHubBuilder}.
      * <p>
@@ -282,38 +309,6 @@ public GitHubBuilder withEndpoint(String endpoint) {
         return this;
     }
 
-    /**
-     * Configures which Jackson implementation to use for JSON serialization/deserialization.
-     *
-     * <p>
-     * By default, Jackson 2.x is used. To use Jackson 3.x, create a Jackson 3 instance using
-     * {@link DefaultGitHubJackson#createJackson3()} and pass it to this method.
-     * </p>
-     *
-     * <h3>Example: Using Jackson 3.x</h3>
-     *
-     * <pre>
-     * GitHub github = new GitHubBuilder().withOAuthToken("token")
-     *         .withJackson(DefaultGitHubJackson.createJackson3())
-     *         .build();
-     * </pre>
-     *
-     * <p>
-     * <strong>Note:</strong> To use Jackson 3.x, you must add the Jackson 3 {@code tools.jackson.core:jackson-databind}
-     * dependency to your project.
-     * </p>
-     *
-     * @param jackson
-     *            the Jackson implementation to use
-     * @return the GitHubBuilder
-     * @see DefaultGitHubJackson#createJackson2()
-     * @see DefaultGitHubJackson#createJackson3()
-     */
-    public GitHubBuilder withJackson(GitHubJackson jackson) {
-        this.jackson = jackson;
-        return this;
-    }
-
     /**
      * With jwt token GitHubBuilder.
      *

src/main/java/org/kohsuke/github/internal/DefaultGitHubJackson.java

@@ -19,9 +19,7 @@
  * GitHub github = new GitHubBuilder().withOAuthToken("token").build();
  *
  * // Using Jackson 3.x
- * GitHub github = new GitHubBuilder().withOAuthToken("token")
- *         .withJackson(DefaultGitHubJackson.createJackson3())
- *         .build();
+ * GitHub github = new GitHubBuilder().withOAuthToken("token").useJackson3().build();
  * </pre>
  *
  * <h2>Jackson 3.x Dependencies</h2>

src/main/java/org/kohsuke/github/internal/GitHubJackson.java

@@ -24,12 +24,12 @@
  *
  * <h2>Configuration</h2>
  * <p>
- * Use {@link org.kohsuke.github.GitHubBuilder#withJackson(GitHubJackson)} to configure which Jackson version to use:
+ * Use {@link org.kohsuke.github.GitHubBuilder#useJackson3()} to configure the client to use Jackson 3.x:
  * </p>
  *
  * <pre>
  * // Use Jackson 3.x
- * GitHub github = new GitHubBuilder().withJackson(DefaultGitHubJackson.createJackson3()).build();
+ * GitHub github = new GitHubBuilder().useJackson3().build();
  * </pre>
  *
  * @author Pierre Villard

src/main/java/org/kohsuke/github/internal/GitHubJackson3.java

@@ -39,7 +39,7 @@
  * </p>
  *
  * <pre>
- * GitHub github = new GitHubBuilder().withJackson(DefaultGitHubJackson.createJackson3()).build();
+ * GitHub github = new GitHubBuilder().useJackson3().build();
  * </pre>
  *
  * @author Pierre Villard

src/test/java/org/kohsuke/github/GitHubJacksonTest.java

@@ -2,14 +2,13 @@
 
 import org.junit.Test;
 import org.kohsuke.github.internal.DefaultGitHubJackson;
-import org.kohsuke.github.internal.GitHubJackson;
 
 import java.io.IOException;
 
 import static org.hamcrest.CoreMatchers.*;
 
 /**
- * Tests for Jackson implementation selection via {@link GitHubBuilder#withJackson(GitHubJackson)}.
+ * Tests for Jackson implementation selection via {@link GitHubBuilder#useJackson3()}.
  */
 public class GitHubJacksonTest extends AbstractGitHubWireMockTest {
 
@@ -33,19 +32,6 @@ public void testDefaultJacksonIsJackson2() throws IOException {
         assertThat(implementationName, startsWith("Jackson 2."));
     }
 
-    /**
-     * Test that Jackson 2 can be explicitly configured via builder.
-     *
-     * @throws IOException
-     *             the io exception
-     */
-    @Test
-    public void testJackson2ViaBuilder() throws IOException {
-        gitHub = getGitHubBuilder().withJackson(DefaultGitHubJackson.createJackson2()).build();
-        String implementationName = gitHub.getClient().getJacksonImplementationName();
-        assertThat(implementationName, startsWith("Jackson 2."));
-    }
-
     /**
      * Test that Jackson 3 can be configured via builder when available.
      *
@@ -55,7 +41,7 @@ public void testJackson2ViaBuilder() throws IOException {
     @Test
     public void testJackson3ViaBuilder() throws IOException {
         if (DefaultGitHubJackson.isJackson3Available()) {
-            gitHub = getGitHubBuilder().withJackson(DefaultGitHubJackson.createJackson3()).build();
+            gitHub = getGitHubBuilder().useJackson3().build();
             String implementationName = gitHub.getClient().getJacksonImplementationName();
             assertThat(implementationName, startsWith("Jackson 3."));
         }