chore: Automate more static code checks (#2028)

Author: valfirst

config/checkstyle/appium-style.xml

@@ -128,6 +128,7 @@
             <message key="name.invalidPattern"
              value="Interface type name ''{0}'' must match pattern ''{1}''."/>
         </module>
+        <module name="ConstantName"/>
         <module name="GenericWhitespace">
             <message key="ws.followed"
              value="GenericWhitespace ''{0}'' is followed by whitespace."/>
@@ -198,6 +199,12 @@
 
         </module>
         <module name="CommentsIndentation"/>
+        <module name="MissingOverride"/>
+        <module name="UnnecessaryParentheses"/>
+        <module name="HideUtilityClassConstructor"/>
+
+        <!-- Make the @SuppressWarnings annotations available to Checkstyle -->
+        <module name="SuppressWarningsHolder"/>
     </module>
     <module name="LineLength">
         <property name="max" value="120"/>
@@ -208,4 +215,7 @@
         <property name="file" value="${config_loc}/suppressions.xml"/>
         <property name="optional" value="false"/>
     </module>
+
+    <!-- Filter out Checkstyle warnings that have been suppressed with the @SuppressWarnings annotation -->
+    <module name="SuppressWarningsFilter"/>
 </module>

src/main/java/io/appium/java_client/AppiumDriver.java

@@ -70,7 +70,7 @@ public class AppiumDriver extends RemoteWebDriver implements
         CanRememberExtensionPresence,
         HasSettings {
 
-    private static final ErrorHandler errorHandler = new ErrorHandler(new ErrorCodesMobile(), true);
+    private static final ErrorHandler ERROR_HANDLER = new ErrorHandler(new ErrorCodesMobile(), true);
     // frequently used command parameters
     private final URL remoteAddress;
     protected final RemoteLocationContext locationContext;
@@ -89,7 +89,7 @@ public AppiumDriver(HttpCommandExecutor executor, Capabilities capabilities) {
         super(executor, capabilities);
         this.executeMethod = new AppiumExecutionMethod(this);
         locationContext = new RemoteLocationContext(executeMethod);
-        super.setErrorHandler(errorHandler);
+        super.setErrorHandler(ERROR_HANDLER);
         this.remoteAddress = executor.getAddressOfRemoteServer();
     }
 
@@ -167,7 +167,7 @@ public AppiumDriver(URL remoteSessionAddress, String platformName, String automa
         setCommandExecutor(executor);
         this.executeMethod = new AppiumExecutionMethod(this);
         locationContext = new RemoteLocationContext(executeMethod);
-        super.setErrorHandler(errorHandler);
+        super.setErrorHandler(ERROR_HANDLER);
         this.remoteAddress = executor.getAddressOfRemoteServer();
 
         setSessionId(sessionAddress.getId());

src/main/java/io/appium/java_client/CommandExecutionHelper.java

@@ -17,8 +17,6 @@
 package io.appium.java_client;
 
 import com.google.common.collect.ImmutableMap;
-import lombok.AccessLevel;
-import lombok.NoArgsConstructor;
 import org.openqa.selenium.remote.Response;
 
 import javax.annotation.Nullable;
@@ -28,9 +26,11 @@
 
 import static org.openqa.selenium.remote.DriverCommand.EXECUTE_SCRIPT;
 
-@NoArgsConstructor(access = AccessLevel.PRIVATE)
 public final class CommandExecutionHelper {
 
+    private CommandExecutionHelper() {
+    }
+
     @Nullable
     public static <T> T execute(
             ExecutesMethod executesMethod, Map.Entry<String, Map<String, ?>> keyValuePair

src/main/java/io/appium/java_client/LogsEvents.java

@@ -63,8 +63,8 @@ default ServerEvents getEvents() {
             .stream()
             .map((Map<String, Object> cmd) -> new CommandEvent(
                 (String) cmd.get("cmd"),
-                ((Long) cmd.get("startTime")),
-                ((Long) cmd.get("endTime"))
+                (Long) cmd.get("startTime"),
+                (Long) cmd.get("endTime")
             ))
             .collect(Collectors.toList());
 

src/main/java/io/appium/java_client/MobileCommand.java

@@ -38,6 +38,7 @@
  * Most of these commands are platform-specific obsolete things and should eventually be replaced with
  * calls to corresponding `mobile:` extensions, so we don't abuse non-w3c APIs
  */
+@SuppressWarnings({"checkstyle:HideUtilityClassConstructor", "checkstyle:ConstantName"})
 public class MobileCommand {
     //General
     @Deprecated
@@ -434,7 +435,7 @@ public static ImmutableMap<String, Object> prepareArguments(String[] params,
                                                                 Object[] values) {
         ImmutableMap.Builder<String, Object> builder = ImmutableMap.builder();
         for (int i = 0; i < params.length; i++) {
-            if (!StringUtils.isBlank(params[i]) && (values[i] != null)) {
+            if (!StringUtils.isBlank(params[i]) && values[i] != null) {
                 builder.put(params[i], values[i]);
             }
         }

src/main/java/io/appium/java_client/android/AndroidMobileCommandHelper.java

@@ -214,8 +214,7 @@ public class AndroidMobileCommandHelper extends MobileCommand {
         String intentAction, String intentCategory, String intentFlags,
         String optionalIntentArguments, boolean stopApp) throws IllegalArgumentException {
 
-        checkArgument((!StringUtils.isBlank(appPackage)
-                && !StringUtils.isBlank(appActivity)),
+        checkArgument(!StringUtils.isBlank(appPackage) && !StringUtils.isBlank(appActivity),
             String.format("'%s' and '%s' are required.", "appPackage", "appActivity"));
 
         String targetWaitPackage = !StringUtils.isBlank(appWaitPackage) ? appWaitPackage : "";

src/main/java/io/appium/java_client/internal/CapabilityHelpers.java

@@ -16,8 +16,6 @@
 
 package io.appium.java_client.internal;
 
-import lombok.AccessLevel;
-import lombok.NoArgsConstructor;
 import org.openqa.selenium.Capabilities;
 
 import javax.annotation.Nullable;
@@ -28,10 +26,12 @@
 import java.util.List;
 import java.util.function.Function;
 
-@NoArgsConstructor(access = AccessLevel.PRIVATE)
 public class CapabilityHelpers {
     public static final String APPIUM_PREFIX = "appium:";
 
+    private CapabilityHelpers() {
+    }
+
     /**
      * Helper that is used for capability values retrieval.
      * Supports both prefixed W3C and "classic" capability names.

src/main/java/io/appium/java_client/internal/Config.java

@@ -11,7 +11,7 @@
 public class Config {
     private static Config mainInstance = null;
     private static final String MAIN_CONFIG = "main.properties";
-    private static final Map<String, Properties> cache = new ConcurrentHashMap<>();
+    private static final Map<String, Properties> CACHE = new ConcurrentHashMap<>();
     private final String configName;
 
     /**
@@ -58,7 +58,7 @@ public <T> T getValue(String key, Class<T> valueType) {
      * @throws ClassCastException if the retrieved value cannot be cast to `valueType` type
      */
     public <T> Optional<T> getOptionalValue(String key, Class<T> valueType) {
-        final Properties cachedProps = cache.computeIfAbsent(configName, k -> {
+        final Properties cachedProps = CACHE.computeIfAbsent(configName, k -> {
             try (InputStream configFileStream = getClass().getClassLoader().getResourceAsStream(configName)) {
                 final Properties p = new Properties();
                 p.load(configFileStream);

src/main/java/io/appium/java_client/internal/ReflectionHelpers.java

@@ -16,15 +16,15 @@
 
 package io.appium.java_client.internal;
 
-import lombok.AccessLevel;
-import lombok.NoArgsConstructor;
 import org.openqa.selenium.WebDriverException;
 
 import java.lang.reflect.Field;
 
-@NoArgsConstructor(access = AccessLevel.PRIVATE)
 public class ReflectionHelpers {
 
+    private ReflectionHelpers() {
+    }
+
     /**
      * Sets the given value to a private instance field.
      *

src/main/java/io/appium/java_client/internal/SessionHelpers.java

@@ -16,9 +16,7 @@
 
 package io.appium.java_client.internal;
 
-import lombok.AccessLevel;
 import lombok.Data;
-import lombok.NoArgsConstructor;
 import org.openqa.selenium.InvalidArgumentException;
 import org.openqa.selenium.WebDriverException;
 
@@ -27,10 +25,12 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-@NoArgsConstructor(access = AccessLevel.PRIVATE)
 public class SessionHelpers {
     private static final Pattern SESSION = Pattern.compile("/session/([^/]+)");
 
+    private SessionHelpers() {
+    }
+
     @Data public static class SessionAddress {
         private final URL serverUrl;
         private final String id;