refactor: format code for improved readability and consistency

Author: JoshiCodes

src/main/java/de/joshicodes/javashock/JavaShock.java

@@ -48,6 +48,7 @@ public JavaShock(final String token, final String apiHost) {
     /**
      * Retrieves all shockers and their hubs from the API.
      * They will automatically be cached.
+     *
      * @return The RestAction to queue or execute
      */
     public RestAction<HashMap<DeviceHub, List<Shocker>>> retrieveAllShockers() {
@@ -58,7 +59,8 @@ public RestAction<HashMap<DeviceHub, List<Shocker>>> retrieveAllShockers() {
      * Caches a hub with its shockers.
      * <b>Does NOT create a new hub or shocker for the user.</b>
      * This Method is designed to be used internally, use with caution.
-     * @param hub The hub to cache
+     *
+     * @param hub      The hub to cache
      * @param shockers The shockers to cache
      */
     public void registerHub(final DeviceHub hub, final List<Shocker> shockers) {
@@ -70,7 +72,8 @@ public void registerHub(final DeviceHub hub, final List<Shocker> shockers) {
      * Caches a shocker in a hub.
      * <b>Does NOT create a new hub or shocker for the user.</b>
      * This Method is designed to be used internally, use with caution.
-     * @param hub The hub to cache the shocker in
+     *
+     * @param hub     The hub to cache the shocker in
      * @param shocker The shocker to cache
      */
     public void registerShocker(final DeviceHub hub, final Shocker shocker) {
@@ -84,14 +87,14 @@ public void registerShocker(final DeviceHub hub, final Shocker shocker) {
     /**
      * Retrieves a shocker by its ID.
      * If the shocker is not cached, it will be fetched from the API.
+     *
      * @param shockerId The ID of the shocker
      * @return The shocker or null if it does not exist
-     *
      * @see #getCachedShocker(String) #getCachedShocker(String) - to fetch the shocker from the cache
      * @see #retrieveShocker(String) #retrieveShocker(String) - to always fetch the shocker from the API
      */
     public RestAction<Shocker> getShocker(final String shockerId) {
-        if(cachedHubs
+        if (cachedHubs
                 .stream()
                 .anyMatch(hub -> hub.getShockers().stream().anyMatch(shock -> shock.getId().equals(shockerId)))
         ) {
@@ -112,9 +115,9 @@ public RestAction<Shocker> getShocker(final String shockerId) {
     /**
      * Retrieves a shocker by its ID.
      * If the shocker is not cached, null will be returned.
+     *
      * @param shockerId The ID of the shocker
      * @return The shocker or null if it does not exist
-     *
      * @see #getShocker(String) - to fetch the shocker from cache or alternatively from the API
      * @see #retrieveShocker(String)  - to always fetch the shocker from the API
      */
@@ -126,9 +129,9 @@ public Shocker getCachedShocker(final String shockerId) {
      * Retrieves a shocker by its ID.
      * This method will always fetch the shocker from the API.
      * Try to use {@link #getShocker(String)} instead.
+     *
      * @param shockerId The ID of the shocker
      * @return The RestAction to queue or execute
-     *
      * @see #getShocker(String) - to fetch the shocker from cache or alternatively from the API
      * @see #getCachedShocker(String) - to fetch the shocker from the cache
      */
@@ -139,10 +142,10 @@ public RestAction<Shocker> retrieveShocker(final String shockerId) {
                 "GET",
                 resp -> {
                     final JsonElement element = resp.getAsJsonElement();
-                    if(element == null) return null;
-                    if(!element.isJsonObject()) return null;
+                    if (element == null) return null;
+                    if (!element.isJsonObject()) return null;
                     final JsonObject object = element.getAsJsonObject();
-                    if(!object.has("data")) return null;
+                    if (!object.has("data")) return null;
                     final JsonObject data = object.getAsJsonObject("data");
                     return Shocker.fromJson(this, data);
                 }
@@ -154,11 +157,12 @@ public RestAction<Shocker> retrieveShocker(final String shockerId) {
      * If hubs are fetched from the API, they do not contain their shockers.
      * Use {@link #retrieveAllShockers()} to retrieve all shockers and hubs instead.
      * <b>This method does not fetch the hub from the api.</b>
+     *
      * @param hubId The ID of the hub
      * @return The hub or null if it does not exist
      */
     public DeviceHub getHub(String hubId) {
-        if(
+        if (
                 cachedHubs
                         .stream()
                         .anyMatch(hub -> hub.getId().equals(hubId))

src/main/java/de/joshicodes/javashock/action/GetShockerAction.java

@@ -20,47 +20,47 @@ public GetShockerAction(final JavaShock instance) {
                 "/1/shockers/own",
                 "GET",
                 (resp) -> {
-            final JsonElement json = resp.getAsJsonElement();
-            final HashMap<DeviceHub, List<Shocker>> list = new HashMap<>();
-            if(json == null) return list;
-            if(!json.isJsonObject()) return list;
-            final JsonObject object = json.getAsJsonObject();
-            if(!object.has("data")) return list;
-            final JsonElement dataElement = object.get("data");
-            if(!dataElement.isJsonArray()) return list;
-            final JsonArray data = dataElement.getAsJsonArray();
-            for(final JsonElement hubElement : data) {
-                if(!hubElement.isJsonObject()) continue;
-                final JsonObject hubObject = hubElement.getAsJsonObject();
-                final String hubId = JsonUtil.getString(hubObject, "id");
-                final String hubName = JsonUtil.getString(hubObject, "name");
-                if(hubId == null || hubName == null) continue;
-                final DeviceHub hub = new DeviceHub(instance, hubId, hubName);
-                if(!hubObject.has("shockers")) continue;
-                final JsonElement shockersElement = hubObject.get("shockers");
-                if(!shockersElement.isJsonArray()) continue;
-                final JsonArray shockersArray = shockersElement.getAsJsonArray();
-                final List<Shocker> shockers = new ArrayList<>();
-                for(final JsonElement shockerElement : shockersArray) {
-                    if(!shockerElement.isJsonObject()) continue;
-                    final JsonObject shockerObject = shockerElement.getAsJsonObject();
-                    final String name = JsonUtil.getString(shockerObject, "name");
-                    final String id = JsonUtil.getString(shockerObject, "id");
-                    final boolean isPaused = JsonUtil.getBoolean(shockerObject, "isPaused");
-                    final long rfId = JsonUtil.getLong(shockerObject, "rfId");
-                    final String model = JsonUtil.getString(shockerObject, "model");
-                    if(name == null || id == null || model == null) continue;
-                    final Shocker shocker = new Shocker(instance, id, name, rfId, model, isPaused, hub.getId());
-                    shockers.add(shocker);
-                }
-                instance.registerHub(
-                        hub,
-                        shockers
-                );
-                list.put(hub, shockers);
-            }
-            return list;
-        });
+                    final JsonElement json = resp.getAsJsonElement();
+                    final HashMap<DeviceHub, List<Shocker>> list = new HashMap<>();
+                    if (json == null) return list;
+                    if (!json.isJsonObject()) return list;
+                    final JsonObject object = json.getAsJsonObject();
+                    if (!object.has("data")) return list;
+                    final JsonElement dataElement = object.get("data");
+                    if (!dataElement.isJsonArray()) return list;
+                    final JsonArray data = dataElement.getAsJsonArray();
+                    for (final JsonElement hubElement : data) {
+                        if (!hubElement.isJsonObject()) continue;
+                        final JsonObject hubObject = hubElement.getAsJsonObject();
+                        final String hubId = JsonUtil.getString(hubObject, "id");
+                        final String hubName = JsonUtil.getString(hubObject, "name");
+                        if (hubId == null || hubName == null) continue;
+                        final DeviceHub hub = new DeviceHub(instance, hubId, hubName);
+                        if (!hubObject.has("shockers")) continue;
+                        final JsonElement shockersElement = hubObject.get("shockers");
+                        if (!shockersElement.isJsonArray()) continue;
+                        final JsonArray shockersArray = shockersElement.getAsJsonArray();
+                        final List<Shocker> shockers = new ArrayList<>();
+                        for (final JsonElement shockerElement : shockersArray) {
+                            if (!shockerElement.isJsonObject()) continue;
+                            final JsonObject shockerObject = shockerElement.getAsJsonObject();
+                            final String name = JsonUtil.getString(shockerObject, "name");
+                            final String id = JsonUtil.getString(shockerObject, "id");
+                            final boolean isPaused = JsonUtil.getBoolean(shockerObject, "isPaused");
+                            final long rfId = JsonUtil.getLong(shockerObject, "rfId");
+                            final String model = JsonUtil.getString(shockerObject, "model");
+                            if (name == null || id == null || model == null) continue;
+                            final Shocker shocker = new Shocker(instance, id, name, rfId, model, isPaused, hub.getId());
+                            shockers.add(shocker);
+                        }
+                        instance.registerHub(
+                                hub,
+                                shockers
+                        );
+                        list.put(hub, shockers);
+                    }
+                    return list;
+                });
     }
 
 }

src/main/java/de/joshicodes/javashock/action/RestAction.java

@@ -43,7 +43,7 @@ public RestAction(final JavaShock instance, final String endpoint, final String
 
     public RestAction(final JavaShock instance, final String endpoint, final String method) {
         this(instance, endpoint, method, Function.identity(), (response) -> {
-            if(response.httpResponse.statusCode() != 200)
+            if (response.httpResponse.statusCode() != 200)
                 throw new RuntimeException("Request failed with status code " + response.httpResponse.statusCode());
             return null;
         });
@@ -71,8 +71,8 @@ public void queue() {
     /**
      * Executes the request asynchronously. <br>
      * If you want to execute the request synchronously, use {@link #execute()} instead.
-     * @param success The consumer that will be called when the request was successful. Can be null.
      *
+     * @param success The consumer that will be called when the request was successful. Can be null.
      * @see #execute()
      * @see #queue()
      * @see #queue(Consumer, Consumer)
@@ -86,9 +86,9 @@ public void queue(final Consumer<T> success) {
     /**
      * Executes the request asynchronously. <br>
      * If you want to execute the request synchronously, use {@link #execute()} instead.
+     *
      * @param success The consumer that will be called when the request was successful. Can be null.
      * @param failure The consumer that will be called when the request failed. Can be null.
-     *
      * @see #execute()
      * @see #queue()
      * @see #queue(Consumer)
@@ -97,16 +97,17 @@ public void queue(final Consumer<T> success, final Consumer<Throwable> failure)
         CompletableFuture.runAsync(() -> {
             try {
                 final T result = execute();
-                if(success != null) success.accept(result);
+                if (success != null) success.accept(result);
             } catch (Throwable e) {
-                if(failure != null) failure.accept(e);
+                if (failure != null) failure.accept(e);
             }
         }).join();
     }
 
     /**
      * Executes the request and returns the result. This method is blocking. <br>
      * If you want to execute the request asynchronously, use {@link #queue()} instead.
+     *
      * @return The result of the request
      */
     public T execute() {
@@ -129,7 +130,7 @@ protected <C> HttpResponse<C> sendRequest(HttpClient client, HttpRequest request
         try {
             return client.send(request, handler);
         } catch (Exception e) {
-            if(retries > 0) {
+            if (retries > 0) {
                 return sendRequest(client, request, handler, retries - 1);
             }
             throw new RuntimeException(e);
@@ -154,7 +155,7 @@ protected HttpRequest.Builder buildRequest() {
                 .uri(URI.create(url))
                 .method(method, body == null ? HttpRequest.BodyPublishers.noBody() : HttpRequest.BodyPublishers.ofString(body));
         // Add body
-        if(body != null && !method.equals("GET")) {
+        if (body != null && !method.equals("GET")) {
             request = request.header("Content-Type", contentType == null ? "application/json" : contentType);
             // send content length
             //request = request.header("Content-Length", String.valueOf(body.length()));
@@ -163,7 +164,7 @@ protected HttpRequest.Builder buildRequest() {
         }
         // Apply headers
         getHeaders().forEach(request::header);
-        if(clientModifier != null) {
+        if (clientModifier != null) {
             request = clientModifier.apply(request);
         }
         return request;
@@ -172,25 +173,25 @@ protected HttpRequest.Builder buildRequest() {
     public record RestResponse<A>(HttpResponse<A> httpResponse, Class<A> aClass) {
 
         public String rawBody() {
-            if(httpResponse.body() == null)
+            if (httpResponse.body() == null)
                 return null;
             return String.valueOf(httpResponse.body());
         }
 
         public JsonElement getAsJsonElement() {
-            if(httpResponse.statusCode() != 200)
+            if (httpResponse.statusCode() != 200)
                 return null;
-            if(httpResponse.body() == null)
+            if (httpResponse.body() == null)
                 return null;
             String body = String.valueOf(httpResponse.body());
-            if(body.isEmpty())
+            if (body.isEmpty())
                 return null;
             return JsonParser.parseString(body);
         }
 
         public JsonObject getAsJsonObject() {
             JsonElement element = getAsJsonElement();
-            if(element == null || !element.isJsonObject())
+            if (element == null || !element.isJsonObject())
                 return new JsonObject();
             return element.getAsJsonObject();
         }

src/main/java/de/joshicodes/javashock/action/SimpleAction.java

@@ -6,6 +6,7 @@
 
 /**
  * Just returns the object that was passed to the constructor.
+ *
  * @param <T>
  */
 public class SimpleAction<T> extends RestAction<T> {

src/main/java/de/joshicodes/javashock/action/control/ControlData.java

@@ -3,6 +3,7 @@
 public record ControlData(ControlType type, int intensity, long duration) {
 
     public enum ControlType {
+
         SHOCK,
         VIBRATE,
         SOUND,

src/main/java/de/joshicodes/javashock/action/control/ControlRequestAction.java

@@ -14,7 +14,7 @@ public class ControlRequestAction extends RestAction<Boolean> {
 
     public ControlRequestAction(JavaShock instance) {
         super(instance, "/2/shockers/control", "POST", resp -> {
-            if(resp.httpResponse().statusCode() != 200)
+            if (resp.httpResponse().statusCode() != 200)
                 throw new RuntimeException("Request failed with status code " + resp.httpResponse().statusCode());
             return true;
         });
@@ -24,10 +24,10 @@ public ControlRequestAction(JavaShock instance) {
 
     public RestAction<Boolean> addShockControl(Shocker shocker, ControlData data) {
         final int intensity = data.intensity();
-        if(intensity < 0 || intensity > 100)
+        if (intensity < 0 || intensity > 100)
             throw new IllegalArgumentException("Intensity must be between 0 and 100");
         final long duration = data.duration();
-        if(duration < 0 || duration > JavaShock.MAX_SHOCK_DURATION)
+        if (duration < 0 || duration > JavaShock.MAX_SHOCK_DURATION)
             throw new IllegalArgumentException("Duration must be between 0 and " + JavaShock.MAX_SHOCK_DURATION);
         this.data.put(shocker, data);
         return this;