adding spotless in common module (#2658)

* adding spotless in common module Signed-off-by: Dhrubo Saha <[email protected]> * applied spotless Signed-off-by: Dhrubo Saha <[email protected]> --------- Signed-off-by: Dhrubo Saha <[email protected]>
opensearch-project · Aug 8, 2024 · 684627a · 684627a
1 parent 1071a48
commit 684627a
Show file tree

Hide file tree

Showing 418 changed files with 9,079 additions and 7,926 deletions.
diff --git a/common/build.gradle b/common/build.gradle
@@ -9,6 +9,7 @@ plugins {
     id 'io.github.goooler.shadow' version "8.1.7"
     id 'jacoco'
     id "io.freefair.lombok"
+    id 'com.diffplug.spotless' version '6.25.0'
     id 'maven-publish'
     id 'signing'
 }
@@ -67,6 +68,15 @@ jacocoTestCoverageVerification {
 }
 check.dependsOn jacocoTestCoverageVerification
 
+spotless {
+    java {
+        removeUnusedImports()
+        importOrder 'java', 'javax', 'org', 'com'
+
+        eclipse().configFile rootProject.file('.eclipseformat.xml')
+    }
+}
+
 shadowJar {
     destinationDirectory = file("${project.buildDir}/distributions")
     archiveClassifier.set(null)
@@ -137,4 +147,4 @@ publishing {
         }
     }
 }
-publishShadowPublicationToMavenLocal.mustRunAfter shadowJar
+publishShadowPublicationToMavenLocal.mustRunAfter shadowJar
diff --git a/common/src/main/java/org/opensearch/ml/common/AccessMode.java b/common/src/main/java/org/opensearch/ml/common/AccessMode.java
@@ -7,11 +7,11 @@
 
 package org.opensearch.ml.common;
 
-import lombok.Getter;
-
 import java.util.HashMap;
 import java.util.Map;
 
+import lombok.Getter;
+
 public enum AccessMode {
     PUBLIC("public"),
     PRIVATE("private"),

diff --git a/common/src/main/java/org/opensearch/ml/common/CommonValue.java b/common/src/main/java/org/opensearch/ml/common/CommonValue.java
diff --git a/common/src/main/java/org/opensearch/ml/common/Configuration.java b/common/src/main/java/org/opensearch/ml/common/Configuration.java
@@ -5,20 +5,21 @@
 
 package org.opensearch.ml.common;
 
-import lombok.Builder;
-import lombok.EqualsAndHashCode;
-import lombok.Getter;
-import lombok.Setter;
+import static org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken;
+
+import java.io.IOException;
+
 import org.opensearch.core.common.io.stream.StreamInput;
 import org.opensearch.core.common.io.stream.StreamOutput;
 import org.opensearch.core.common.io.stream.Writeable;
 import org.opensearch.core.xcontent.ToXContentObject;
 import org.opensearch.core.xcontent.XContentBuilder;
 import org.opensearch.core.xcontent.XContentParser;
 
-import java.io.IOException;
-
-import static org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken;
+import lombok.Builder;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.Setter;
 
 @Getter
 @EqualsAndHashCode
@@ -30,9 +31,7 @@ public class Configuration implements ToXContentObject, Writeable {
     private String agentId;
 
     @Builder(toBuilder = true)
-    public Configuration(
-        String agentId
-    ) {
+    public Configuration(String agentId) {
         this.agentId = agentId;
     }
 
@@ -76,8 +75,6 @@ public static Configuration parse(XContentParser parser) throws IOException {
                     break;
             }
         }
-        return Configuration.builder()
-                .agentId(agentId)
-                .build();
+        return Configuration.builder().agentId(agentId).build();
     }
 }
diff --git a/common/src/main/java/org/opensearch/ml/common/FunctionName.java b/common/src/main/java/org/opensearch/ml/common/FunctionName.java
@@ -41,13 +41,9 @@ public static FunctionName from(String value) {
         }
     }
 
-    private static final HashSet<FunctionName> DL_MODELS = new HashSet<>(Set.of(
-        TEXT_EMBEDDING,
-        TEXT_SIMILARITY,
-        SPARSE_ENCODING,
-        SPARSE_TOKENIZE,
-        QUESTION_ANSWERING
-    ));
+    private static final HashSet<FunctionName> DL_MODELS = new HashSet<>(
+        Set.of(TEXT_EMBEDDING, TEXT_SIMILARITY, SPARSE_ENCODING, SPARSE_TOKENIZE, QUESTION_ANSWERING)
+    );
 
     /**
      * Check if model is deep learning model.

diff --git a/common/src/main/java/org/opensearch/ml/common/MLCommonsClassLoader.java b/common/src/main/java/org/opensearch/ml/common/MLCommonsClassLoader.java
@@ -5,7 +5,15 @@
 
 package org.opensearch.ml.common;
 
-import lombok.extern.log4j.Log4j2;
+import java.io.IOException;
+import java.lang.reflect.Constructor;
+import java.security.AccessController;
+import java.security.PrivilegedActionException;
+import java.security.PrivilegedExceptionAction;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
+
 import org.opensearch.core.common.io.stream.StreamInput;
 import org.opensearch.ml.common.annotation.Connector;
 import org.opensearch.ml.common.annotation.ExecuteInput;
@@ -20,14 +28,7 @@
 import org.opensearch.ml.common.output.MLOutputType;
 import org.reflections.Reflections;
 
-import java.io.IOException;
-import java.lang.reflect.Constructor;
-import java.security.AccessController;
-import java.security.PrivilegedActionException;
-import java.security.PrivilegedExceptionAction;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.Set;
+import lombok.extern.log4j.Log4j2;
 
 @Log4j2
 @SuppressWarnings("removal")
@@ -93,7 +94,7 @@ private static void loadMLAlgoParameterClassMapping() {
             if (mlAlgoParameter != null) {
                 FunctionName[] algorithms = mlAlgoParameter.algorithms();
                 if (algorithms != null && algorithms.length > 0) {
-                    for(FunctionName name : algorithms){
+                    for (FunctionName name : algorithms) {
                         parameterClassMap.put(name, clazz);
                     }
                 }
@@ -157,7 +158,7 @@ private static void loadExecuteInputClassMapping() {
             if (executeInput != null) {
                 FunctionName[] algorithms = executeInput.algorithms();
                 if (algorithms != null && algorithms.length > 0) {
-                    for(FunctionName name : algorithms){
+                    for (FunctionName name : algorithms) {
                         executeInputClassMap.put(name, clazz);
                     }
                 }
@@ -176,7 +177,7 @@ private static void loadExecuteOutputClassMapping() {
             if (executeOutput != null) {
                 FunctionName[] algorithms = executeOutput.algorithms();
                 if (algorithms != null && algorithms.length > 0) {
-                    for(FunctionName name : algorithms){
+                    for (FunctionName name : algorithms) {
                         executeOutputClassMap.put(name, clazz);
                     }
                 }
@@ -192,7 +193,7 @@ private static void loadMLInputClassMapping() {
             if (mlInput != null) {
                 FunctionName[] algorithms = mlInput.functionNames();
                 if (algorithms != null && algorithms.length > 0) {
-                    for(FunctionName name : algorithms){
+                    for (FunctionName name : algorithms) {
                         mlInputClassMap.put(name, clazz);
                     }
                 }
@@ -242,7 +243,7 @@ private static <T, S, I extends Object> S init(Map<T, Class<?>> map, T type, I i
         } catch (Exception e) {
             Throwable cause = e.getCause();
             if (cause instanceof MLException || cause instanceof IllegalArgumentException) {
-                throw (RuntimeException)cause;
+                throw (RuntimeException) cause;
             } else {
                 log.error("Failed to init instance for type " + type, e);
                 return null;
@@ -254,19 +255,16 @@ public static boolean canInitMLInput(FunctionName functionName) {
         return mlInputClassMap.containsKey(functionName);
     }
 
-    public static <S> S initConnector(String name, Object[] initArgs,
-                                      Class<?>... constructorParameterTypes) {
+    public static <S> S initConnector(String name, Object[] initArgs, Class<?>... constructorParameterTypes) {
         return init(connectorClassMap, name, initArgs, constructorParameterTypes);
     }
 
     @SuppressWarnings("unchecked")
-    public static <T extends Enum<T>, S> S initMLInput(T type, Object[] initArgs,
-                                                       Class<?>... constructorParameterTypes) {
+    public static <T extends Enum<T>, S> S initMLInput(T type, Object[] initArgs, Class<?>... constructorParameterTypes) {
         return init(mlInputClassMap, type, initArgs, constructorParameterTypes);
     }
 
-    private static <T, S> S init(Map<T, Class<?>> map, T type,
-                                 Object[] initArgs, Class<?>... constructorParameterTypes) {
+    private static <T, S> S init(Map<T, Class<?>> map, T type, Object[] initArgs, Class<?>... constructorParameterTypes) {
         Class<?> clazz = map.get(type);
         if (clazz == null) {
             throw new IllegalArgumentException("Can't find class for type " + type);
@@ -277,7 +275,7 @@ private static <T, S> S init(Map<T, Class<?>> map, T type,
         } catch (Exception e) {
             Throwable cause = e.getCause();
             if (cause instanceof MLException) {
-                throw (MLException)cause;
+                throw (MLException) cause;
             } else if (cause instanceof IllegalArgumentException) {
                 throw (IllegalArgumentException) cause;
             } else {

diff --git a/common/src/main/java/org/opensearch/ml/common/MLConfig.java b/common/src/main/java/org/opensearch/ml/common/MLConfig.java
@@ -5,21 +5,22 @@
 
 package org.opensearch.ml.common;
 
-import lombok.Builder;
-import lombok.EqualsAndHashCode;
-import lombok.Getter;
-import lombok.Setter;
+import static org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken;
+
+import java.io.IOException;
+import java.time.Instant;
+
 import org.opensearch.core.common.io.stream.StreamInput;
 import org.opensearch.core.common.io.stream.StreamOutput;
 import org.opensearch.core.common.io.stream.Writeable;
 import org.opensearch.core.xcontent.ToXContentObject;
 import org.opensearch.core.xcontent.XContentBuilder;
 import org.opensearch.core.xcontent.XContentParser;
 
-import java.io.IOException;
-import java.time.Instant;
-
-import static org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken;
+import lombok.Builder;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.Setter;
 
 @Getter
 @EqualsAndHashCode
@@ -38,7 +39,6 @@ public class MLConfig implements ToXContentObject, Writeable {
 
     public static final String LAST_UPDATED_TIME_FIELD = "last_updated_time";
 
-
     @Setter
     private String type;
 
@@ -47,12 +47,7 @@ public class MLConfig implements ToXContentObject, Writeable {
     private Instant lastUpdateTime;
 
     @Builder(toBuilder = true)
-    public MLConfig(
-            String type,
-            Configuration configuration,
-            Instant createTime,
-            Instant lastUpdateTime
-    ) {
+    public MLConfig(String type, Configuration configuration, Instant createTime, Instant lastUpdateTime) {
         this.type = type;
         this.configuration = configuration;
         this.createTime = createTime;
@@ -145,11 +140,12 @@ public static MLConfig parse(XContentParser parser) throws IOException {
                     break;
             }
         }
-        return MLConfig.builder()
-                .type(configType == null ? type : configType)
-                .configuration(mlConfiguration == null ? configuration : mlConfiguration)
-                .createTime(createTime)
-                .lastUpdateTime(lastUpdatedTime == null ? lastUpdateTime : lastUpdatedTime)
-                .build();
+        return MLConfig
+            .builder()
+            .type(configType == null ? type : configType)
+            .configuration(mlConfiguration == null ? configuration : mlConfiguration)
+            .createTime(createTime)
+            .lastUpdateTime(lastUpdatedTime == null ? lastUpdateTime : lastUpdatedTime)
+            .build();
     }
 }