Document Java request lifecycle hooks

Author: kvz

src/main/java/io/tus/java/client/TusClient.java

@@ -402,7 +402,9 @@ public void prepareConnection(@NotNull HttpURLConnection connection) {
         }
     }
 
-    void runBeforeRequest(@NotNull String method, @NotNull HttpURLConnection connection) throws IOException {
+    final void runBeforeRequest(
+            @NotNull String method, @NotNull HttpURLConnection connection
+    ) throws IOException {
         if (requestLifecycleHooks == null || requestLifecycleHooks.getBeforeRequest() == null) {
             return;
         }
@@ -412,7 +414,9 @@ void runBeforeRequest(@NotNull String method, @NotNull HttpURLConnection connect
         );
     }
 
-    void runAfterResponse(@NotNull String method, @NotNull HttpURLConnection connection) throws IOException {
+    final void runAfterResponse(
+            @NotNull String method, @NotNull HttpURLConnection connection
+    ) throws IOException {
         if (requestLifecycleHooks == null || requestLifecycleHooks.getAfterResponse() == null) {
             return;
         }

src/main/java/io/tus/java/client/TusRequestLifecycleHooks.java

@@ -19,10 +19,20 @@ public static final class RequestContext {
             this.connection = connection;
         }
 
+        /**
+         * Get the logical TUS request method for this request.
+         *
+         * @return The request method.
+         */
         public String getMethod() {
             return method;
         }
 
+        /**
+         * Get the HTTP connection for this request.
+         *
+         * @return The mutable HTTP connection.
+         */
         public HttpURLConnection getConnection() {
             return connection;
         }
@@ -32,19 +42,37 @@ public HttpURLConnection getConnection() {
      * Callback invoked before transport sends the request.
      */
     public interface BeforeRequest {
+        /**
+         * Handle a request before it is sent.
+         *
+         * @param context The request context.
+         * @throws IOException when the request should fail.
+         */
         void beforeRequest(RequestContext context) throws IOException;
     }
 
     /**
      * Callback invoked after transport receives the response.
      */
     public interface AfterResponse {
+        /**
+         * Handle a response after it has been received.
+         *
+         * @param context The request context.
+         * @throws IOException when the response should fail.
+         */
         void afterResponse(RequestContext context) throws IOException;
     }
 
     private final BeforeRequest beforeRequest;
     private final AfterResponse afterResponse;
 
+    /**
+     * Create request lifecycle hooks.
+     *
+     * @param beforeRequest Callback invoked before a request is sent.
+     * @param afterResponse Callback invoked after a response is received.
+     */
     public TusRequestLifecycleHooks(BeforeRequest beforeRequest, AfterResponse afterResponse) {
         this.beforeRequest = beforeRequest;
         this.afterResponse = afterResponse;