Merge pull request hub4j#1307 from bitwiseman/task/urlcleanup

Code cleanup

Author: bitwiseman

pom.xml

@@ -342,6 +342,12 @@
         </executions>
         <configuration>
           <java>
+            <includes>
+              <include>src/main/java/**/*.java</include>
+              <include>src/main/java11/**/*.java</include>
+              <include>src/test/java/**/*.java</include>
+            </includes>
+
             <eclipse>
               <file>${basedir}/src/build/eclipse/formatter.xml</file>
             </eclipse>

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

@@ -37,6 +37,8 @@
  * @param <S>
  *            Intermediate return type for this builder returned by calls to {@link #with(String, Object)}. If {@link S}
  *            the same as {@link R}, this builder will commit changes after each call to {@link #with(String, Object)}.
+ *
+ * @author Liam Newman
  */
 abstract class AbstractBuilder<R, S> extends GitHubInteractiveObject {
 

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

@@ -16,6 +16,7 @@
  *      GitHubBuilder#withAbuseLimitHandler(GitHubAbuseLimitHandler)
  * @see <a href="https://developer.github.com/v3/#abuse-rate-limits">documentation</a>
  * @see RateLimitHandler
+ * @deprecated Switch to {@link GitHubAbuseLimitHandler}.
  */
 @Deprecated
 public abstract class AbuseLimitHandler extends GitHubAbuseLimitHandler {

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

@@ -24,7 +24,7 @@
 /**
  * Rate limit.
  *
- * @author Kohsuke Kawaguchi
+ * @author Liam Newman
  */
 @SuppressFBWarnings(value = "URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD", justification = "JSON API")
 public class GHRateLimit {
@@ -380,6 +380,7 @@ static void reset() {
      * A rate limit record.
      *
      * @since 1.100
+     * @author Liam Newman
      */
     public static class Record {
         /**

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

@@ -13,6 +13,8 @@
  * @author Kohsuke Kawaguchi
  * @see GitHubBuilder#withAbuseLimitHandler(AbuseLimitHandler) GitHubBuilder#withRateLimitHandler(AbuseLimitHandler)
  * @see GitHubRateLimitHandler
+ *
+ * @author Liam Newman
  */
 public abstract class GitHubAbuseLimitHandler extends GitHubConnectorResponseErrorHandler {
 

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

@@ -8,7 +8,7 @@
 import org.kohsuke.github.connector.GitHubConnector;
 import org.kohsuke.github.connector.GitHubConnectorRequest;
 import org.kohsuke.github.connector.GitHubConnectorResponse;
-import org.kohsuke.github.function.BodyHandler;
+import org.kohsuke.github.function.FunctionThrows;
 
 import java.io.*;
 import java.net.*;
@@ -33,9 +33,14 @@
 /**
  * A GitHub API Client
  * <p>
- * A GitHubClient can be used to send requests and retrieve their responses. GitHubClient is thread-safe and can be used
- * to send multiple requests. GitHubClient also track some GitHub API information such as {@link GHRateLimit}.
+ * A GitHubClient can be used to send requests and retrieve their responses. Uses {@link GitHubConnector} as a pluggable
+ * component to communicate using differing HTTP client libraries.
+ * <p>
+ * GitHubClient is thread-safe and can be used to send multiple requests simultaneously. GitHubClient also tracks some
+ * GitHub API information such as {@link GHRateLimit}.
  * </p>
+ *
+ * @author Liam Newman
  */
 class GitHubClient {
 
@@ -764,4 +769,14 @@ static class RetryRequestException extends IOException {
             this.connectorRequest = connectorRequest;
         }
     }
+
+    /**
+     * Represents a supplier of results that can throw.
+     *
+     * @param <T>
+     *            the type of results supplied by this supplier
+     */
+    @FunctionalInterface
+    interface BodyHandler<T> extends FunctionThrows<GitHubConnectorResponse, T, IOException> {
+    }
 }

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

@@ -12,8 +12,7 @@
 import static java.net.HttpURLConnection.HTTP_NOT_FOUND;
 
 /**
- * Pluggable strategy to determine what to detect and choose what to do when various errors occur during an http
- * request.
+ * Pluggable strategy to detect and choose what to do when errors occur during an http request.
  *
  * @author Liam Newman
  */

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

@@ -13,6 +13,8 @@
  * Ensures that all data references to GitHub connection are transient.
  *
  * Classes that do not need to interact with GitHub after they are instantiated do not need to inherit from this class.
+ *
+ * @author Liam Newman
  */
 abstract class GitHubInteractiveObject {
     @JacksonInject

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

@@ -14,6 +14,8 @@
  *
  * @param <T>
  *            the type of items on each page
+ *
+ * @author Liam Newman
  */
 class GitHubPageContentsIterable<T> extends PagedIterable<T> {
 

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

@@ -19,6 +19,8 @@
  *
  * @param <T>
  *            type of each page (not the items in the page).
+ *
+ * @author Liam Newman
  */
 class GitHubPageIterator<T> implements Iterator<T> {