Remove validateResponseCodes

Add various helper methods for validating response codes instead

Author: absurdlylongusername

extractor/src/main/java/org/schabi/newpipe/extractor/downloader/Response.java

@@ -2,16 +2,17 @@
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
-import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
+import java.util.function.Function;
 
 import org.schabi.newpipe.extractor.exceptions.HttpResponseException;
 
 /**
  * A Data class used to hold the results from requests made by the Downloader implementation.
  */
+@SuppressWarnings("checkstyle:NeedBraces")
 public class Response {
     private final int responseCode;
     private final String responseMessage;
@@ -33,29 +34,6 @@ public Response(final int responseCode,
         this.latestUrl = latestUrl;
     }
 
-    // CHECKSTYLE:OFF
-    /**
-     * Validates the response codes for the given {@link Response}, and throws
-     * a {@link HttpResponseException} if the code is invalid
-     * @param response The response to validate
-     * @param validResponseCodes Expected valid response codes
-     * @throws HttpResponseException Thrown when the response code is not in {@code validResponseCodes},
-     * or when {@code  validResponseCodes} is empty and the code is a 4xx or 5xx error.
-     */
-    // CHECKSTYLE:ON
-    public static void validateResponseCode(final Response response,
-                                            final int... validResponseCodes)
-        throws HttpResponseException {
-        final int code = response.responseCode();
-        final var throwError = (validResponseCodes == null || validResponseCodes.length == 0)
-            ? code >= 400 && code <= 599
-            : Arrays.stream(validResponseCodes).noneMatch(c -> c == code);
-
-        if (throwError) {
-            throw new HttpResponseException(response);
-        }
-    }
-
     public int responseCode() {
         return responseCode;
     }
@@ -107,21 +85,128 @@ public String getHeader(final String name) {
         return null;
     }
 
-    // CHECKSTYLE:OFF
     /**
-     * Helper function simply to make it easier to validate response code inline
-     * before getting the code/body/latestUrl/etc.
-     * Validates the response codes for the given {@link Response}, and throws a {@link HttpResponseException} if the code is invalid
-     * @see Response#validateResponseCode(Response, int...)
-     * @param validResponseCodes Expected valid response codes
-     * @return {@link this} response
-     * @throws HttpResponseException Thrown when the response code is not in {@code validResponseCodes},
-     * or when {@code  validResponseCodes} is empty and the code is a 4xx or 5xx error.
+     * Ensure the response code is 2xx
+     * @return this {@code Response}
+     * @throws HttpResponseException if the response code is not 2xx
+     */
+    public Response ensureSuccessResponseCode() throws HttpResponseException {
+        return ensureResponseCodeInRange(200, 299);
+    }
+
+    /**
+     * Ensure the response code is 3xx
+     * @return this {@code Response}
+     * @throws HttpResponseException if the response code is not 3xx
+     */
+    public Response ensureRedirectResponseCode() throws HttpResponseException {
+        return ensureResponseCodeInRange(300, 399);
+    }
+
+    /**
+     * Ensure the response code is not 4xx or 5xx
+     * @return this {@code Response}
+     * @throws HttpResponseException if the response code is client or server error
+     */
+    public Response ensureResponseCodeIsNotError() throws HttpResponseException {
+        return ensureResponseCodeNotInRange(400, 599);
+    }
+
+    /**
+     * Ensure the HTTP response code is within range of min and max inclusive
+     * @return this Response
+     * @throws HttpResponseException if the code is outside the range
+     */
+    public Response ensureResponseCodeInRange(final int min, final int max)
+        throws HttpResponseException {
+        if (responseCode() < min || responseCode() > max) {
+            throw new HttpResponseException(this);
+        }
+        return this;
+    }
+
+    public Response ensureResponseCodeNotInRange(
+        final int min,
+        final int max,
+        final Function<Response, HttpResponseException> errorSupplier
+    )
+        throws HttpResponseException {
+        if (min > max) throw new RuntimeException("min must be less than max");
+        if (responseCode() >= min && responseCode() <= max) {
+            throw errorSupplier.apply(this);
+        }
+        return this;
+    }
+
+    public Response ensureResponseCodeNotInRange(final int min, final int max)
+        throws HttpResponseException {
+        return ensureResponseCodeNotInRange(min, max, HttpResponseException::new);
+    }
+
+    /**
+     * Throw exception if response code is a 4xx client error
+     * @return this {@code Response}
+     * @throws HttpResponseException if the response code is 4xx
+     */
+    public Response throwIfClientError(
+        final Function<Response, HttpResponseException> errorSupplier
+    )
+        throws HttpResponseException {
+        return throwIfResponseCodeInRange(400, 499, errorSupplier);
+    }
+
+    /**
+     * Throw exception if response code is a 4xx client error
+     * @return this {@code Response}
+     * @throws HttpResponseException if the response code is 4xx
+     */
+    public Response throwIfClientError()
+        throws HttpResponseException {
+        return throwIfClientError(HttpResponseException::new);
+    }
+
+    /**
+     * Throw exception if response code is a 5xx server error
+     * @return this {@code Response}
+     * @throws HttpResponseException if the response code is 4xx
      */
-    // CHECKSTYLE:ON
-    public Response validateResponseCode(final int... validResponseCodes)
+    public Response throwIfServerError(
+        final Function<Response, HttpResponseException> errorSupplier
+    )
         throws HttpResponseException {
-        validateResponseCode(this, validResponseCodes);
+        return throwIfResponseCodeInRange(500, 599, errorSupplier);
+    }
+
+    public Response throwIfServerError()
+        throws HttpResponseException {
+        return throwIfServerError(HttpResponseException::new);
+    }
+
+    public Response throwIfResponseCode(
+        final int errorCode,
+        final Function<Response, HttpResponseException> errorSupplier
+    )
+        throws HttpResponseException {
+        if (responseCode() == errorCode) {
+            throw errorSupplier.apply(this);
+        }
         return this;
     }
+
+    public Response throwIfResponseCode(final int errorCode) throws HttpResponseException {
+        return throwIfResponseCode(errorCode, HttpResponseException::new);
+    }
+
+    public Response throwIfResponseCodeInRange(final int min,
+                                               final int max,
+                                               final Function<Response,
+                                                              HttpResponseException> errorSupplier)
+        throws HttpResponseException {
+        return ensureResponseCodeNotInRange(min, max, errorSupplier);
+    }
+
+    public Response throwIfResponseCodeInRange(final int min,
+                                               final int max) throws HttpResponseException {
+        return throwIfResponseCodeInRange(min, max, HttpResponseException::new);
+    }
 }