CM-2344: Fixed warnings related to unused imports, final modifiers, etc.

yaricom · yaricom · commit 1d45669c131f · 2022-10-13T17:31:42.000+03:00
diff --git a/comet-examples/src/main/java/ml/comet/examples/mnist/MnistExperimentExample.java b/comet-examples/src/main/java/ml/comet/examples/mnist/MnistExperimentExample.java
@@ -48,6 +48,7 @@ public final class MnistExperimentExample {
      * The number of epochs to perform.
      */
     @Parameter(names = {"--epochs", "-e"}, description = "number of epochs to perform")
+    final
     int numEpochs = 2;
 
     /**
diff --git a/comet-java-client/src/main/java/ml/comet/experiment/builder/OnlineExperimentBuilder.java b/comet-java-client/src/main/java/ml/comet/experiment/builder/OnlineExperimentBuilder.java
@@ -34,7 +34,7 @@ public interface OnlineExperimentBuilder extends BaseCometBuilder<OnlineExperime
     /**
      * Set the URL of your comet installation.
      *
-     * @param urlOverride full url of comet installation. Default is https://www.comet.ml
+     * @param urlOverride full url of comet installation. Default is https://www.comet.com
      * @return the builder configured with specified URL of the Comet installation.
      */
     OnlineExperimentBuilder withUrlOverride(String urlOverride);
diff --git a/comet-java-client/src/main/java/ml/comet/experiment/impl/BaseExperimentAsync.java b/comet-java-client/src/main/java/ml/comet/experiment/impl/BaseExperimentAsync.java
@@ -75,7 +75,7 @@
  * using asynchronous networking.
  */
 abstract class BaseExperimentAsync extends BaseExperiment {
-    ExperimentContext baseContext;
+    final ExperimentContext baseContext;
 
     BaseExperimentAsync(@NonNull final String apiKey,
                         @NonNull final String baseUrl,
diff --git a/comet-java-client/src/main/java/ml/comet/experiment/impl/OnlineExperimentImpl.java b/comet-java-client/src/main/java/ml/comet/experiment/impl/OnlineExperimentImpl.java
@@ -755,7 +755,7 @@ Optional<Action> getLogAssetOnCompleteAction() {
      * The runnable to be invoked to send periodic heartbeat ping to mark this experiment as still running.
      */
     static class HeartbeatPing implements Runnable {
-        OnlineExperimentImpl onlineExperiment;
+        final OnlineExperimentImpl onlineExperiment;
 
         HeartbeatPing(OnlineExperimentImpl onlineExperiment) {
             this.onlineExperiment = onlineExperiment;
diff --git a/comet-java-client/src/main/java/ml/comet/experiment/impl/asset/DownloadArtifactAssetOptions.java b/comet-java-client/src/main/java/ml/comet/experiment/impl/asset/DownloadArtifactAssetOptions.java
@@ -1,6 +1,5 @@
 package ml.comet.experiment.impl.asset;
 
-import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;
diff --git a/comet-java-client/src/main/java/ml/comet/experiment/impl/asset/RemoteAssetImpl.java b/comet-java-client/src/main/java/ml/comet/experiment/impl/asset/RemoteAssetImpl.java
@@ -2,7 +2,6 @@
 
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
-import lombok.NoArgsConstructor;
 import lombok.Setter;
 import ml.comet.experiment.asset.RemoteAsset;
 
diff --git a/comet-java-client/src/main/java/ml/comet/experiment/impl/log/StdOutLogger.java b/comet-java-client/src/main/java/ml/comet/experiment/impl/log/StdOutLogger.java
@@ -20,11 +20,11 @@
 public class StdOutLogger implements Runnable, Closeable {
     final AtomicLong offset = new AtomicLong();
 
-    OutputStream outputStream;
-    InputStream inputStream;
-    PrintStream original;
-    OnlineExperiment experiment;
-    boolean stdOut;
+    final OutputStream outputStream;
+    final InputStream inputStream;
+    final PrintStream original;
+    final OnlineExperiment experiment;
+    final boolean stdOut;
 
     /**
      * Creates logger instance that captures StdOut stream for a given OnlineExperiment.
diff --git a/comet-java-client/src/main/java/ml/comet/experiment/impl/utils/ExceptionUtils.java b/comet-java-client/src/main/java/ml/comet/experiment/impl/utils/ExceptionUtils.java
@@ -1,7 +1,5 @@
 package ml.comet.experiment.impl.utils;
 
-import ml.comet.experiment.exception.CometApiException;
-
 import java.util.Objects;
 
 /**
diff --git a/comet-java-client/src/test/java/ml/comet/experiment/impl/ApiExperimentTest.java b/comet-java-client/src/test/java/ml/comet/experiment/impl/ApiExperimentTest.java
@@ -36,11 +36,11 @@
 @DisplayName("ApiExperimentTest INTEGRATION")
 @Tag("integration")
 public class ApiExperimentTest {
-    static Map<String, Object> SOME_METADATA = new HashMap<String, Object>() {{
+    static final Map<String, Object> SOME_METADATA = new HashMap<String, Object>() {{
         put("someString", "string");
         put("someInt", 10);
     }};
-    static String SOME_TEXT = "this is some text to be used";
+    static final String SOME_TEXT = "this is some text to be used";
 
     @Test
     public void testApiExperimentInitializedWithInvalidValues() {
diff --git a/comet-java-client/src/test/java/ml/comet/experiment/impl/ArtifactImplTest.java b/comet-java-client/src/test/java/ml/comet/experiment/impl/ArtifactImplTest.java
@@ -35,20 +35,20 @@
 @DisplayName("Artifact")
 public class ArtifactImplTest extends AssetsBaseTest {
 
-    static String SOME_ARTIFACT_NAME = "artifactName";
-    static String SOME_ARTIFACT_TYPE = "artifactType";
-    static List<String> SOME_ALIASES = Arrays.asList("one", "two", "three", "three");
-    static Set<String> UNIQUE_ALIASES = new HashSet<>(SOME_ALIASES);
-    static List<String> SOME_TAGS = Arrays.asList("tag_1", "tag_2", "tag_3", "tag_3");
-    static Set<String> UNIQUE_TAGS = new HashSet<>(SOME_TAGS);
-    static String SOME_VERSION = "1.2.3-beta.4+sha899d8g79f87";
-    static String INVALID_VERSION = "1.2";
-    static Map<String, Object> SOME_METADATA = new HashMap<String, Object>() {{
+    static final String SOME_ARTIFACT_NAME = "artifactName";
+    static final String SOME_ARTIFACT_TYPE = "artifactType";
+    static final List<String> SOME_ALIASES = Arrays.asList("one", "two", "three", "three");
+    static final Set<String> UNIQUE_ALIASES = new HashSet<>(SOME_ALIASES);
+    static final List<String> SOME_TAGS = Arrays.asList("tag_1", "tag_2", "tag_3", "tag_3");
+    static final Set<String> UNIQUE_TAGS = new HashSet<>(SOME_TAGS);
+    static final String SOME_VERSION = "1.2.3-beta.4+sha899d8g79f87";
+    static final String INVALID_VERSION = "1.2";
+    static final Map<String, Object> SOME_METADATA = new HashMap<String, Object>() {{
         put("someString", "string");
         put("someInt", 10);
     }};
-    static String SOME_REMOTE_ASSET_LINK = "s3://bucket/folder/someFile";
-    static String SOME_REMOTE_ASSET_NAME = "someRemoteAsset";
+    static final String SOME_REMOTE_ASSET_LINK = "s3://bucket/folder/someFile";
+    static final String SOME_REMOTE_ASSET_NAME = "someRemoteAsset";
 
     @Test
     @DisplayName("is created with newArtifact()")
@@ -143,7 +143,7 @@ void hasNoAssets() {
         class AfterAddingFileAssetTest {
             File assetFile;
             String assetFileName;
-            boolean overwrite = true;
+            final boolean overwrite = true;
 
             @BeforeEach
             void addFileAsset() {
@@ -175,7 +175,7 @@ void throwsExceptionWhenAddingSameName() {
         class AfterAddingFileLikeAssetTest {
             byte[] data;
             String assetFileName;
-            boolean overwrite = true;
+            final boolean overwrite = true;
 
             @BeforeEach
             void addFileLikeAsset() {
@@ -207,7 +207,7 @@ void throwsExceptionWhenAddingSameName() {
         class AfterAddingRemoteAssetTest {
             URI uri;
             String assetFileName;
-            boolean overwrite = true;
+            final boolean overwrite = true;
 
             @BeforeEach
             void addRemoteAsset() throws URISyntaxException {
@@ -238,8 +238,8 @@ void throwsExceptionWhenAddingSameName() {
         @Nested
         @DisplayName("after adding assets folder")
         class AfterAddingAssetsFolderTest {
-            boolean logFilePath = true;
-            boolean recursive = true;
+            final boolean logFilePath = true;
+            final boolean recursive = true;
 
             @BeforeEach
             void addAssetsFolder() throws IOException {
diff --git a/comet-java-client/src/test/java/ml/comet/experiment/impl/CometApiTest.java b/comet-java-client/src/test/java/ml/comet/experiment/impl/CometApiTest.java
@@ -54,7 +54,6 @@
 import static ml.comet.experiment.impl.asset.AssetType.MODEL_ELEMENT;
 import static ml.comet.experiment.impl.resources.LogMessages.EXPERIMENT_HAS_NO_MODELS;
 import static ml.comet.experiment.impl.resources.LogMessages.getString;
-import static org.junit.jupiter.api.Assertions.assertAll;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
diff --git a/comet-java-client/src/test/java/ml/comet/experiment/impl/DownloadedArtifactImplTest.java b/comet-java-client/src/test/java/ml/comet/experiment/impl/DownloadedArtifactImplTest.java
@@ -34,10 +34,10 @@
  */
 @DisplayName("Downloaded Artifact")
 public class DownloadedArtifactImplTest extends AssetsBaseTest {
-    static String SOME_VERSION_STRING = "1.0.0";
-    static String SOME_UP_VERSION_STRING = "1.1.0";
-    static String SOME_DOWN_VERSION_STRING = "0.1.0";
-    static Semver SOME_VERSION = new Semver(SOME_VERSION_STRING);
+    static final String SOME_VERSION_STRING = "1.0.0";
+    static final String SOME_UP_VERSION_STRING = "1.1.0";
+    static final String SOME_DOWN_VERSION_STRING = "0.1.0";
+    static final Semver SOME_VERSION = new Semver(SOME_VERSION_STRING);
 
     @Test
     @DisplayName("is created with new")
@@ -187,7 +187,7 @@ class AfterUpdatingLoggedFileAssetTest {
                 File assetFile;
                 File anotherAssetFile;
                 String logicalPath;
-                boolean overwrite = true;
+                final boolean overwrite = true;
 
                 @BeforeEach
                 void updateFileAsset(){
@@ -222,7 +222,7 @@ class AfterUpdatingLoggedRemoteAssetTest {
                 URI remoteUri;
                 URI anotherRemoteUri;
                 String logicalPath;
-                boolean overwrite = true;
+                final boolean overwrite = true;
 
                 @BeforeEach
                 void updateRemoteAsset() throws URISyntaxException {
diff --git a/comet-java-client/src/test/java/ml/comet/experiment/impl/ExperimentTestFactory.java b/comet-java-client/src/test/java/ml/comet/experiment/impl/ExperimentTestFactory.java
@@ -12,9 +12,9 @@
  * The factory to create initialized experiment instances for testing.
  */
 public class ExperimentTestFactory {
-    static String API_KEY;
-    static String PROJECT_NAME;
-    static String WORKSPACE_NAME;
+    static final String API_KEY;
+    static final String PROJECT_NAME;
+    static final String WORKSPACE_NAME;
 
     static {
         API_KEY = COMET_API_KEY.getString();
diff --git a/comet-java-client/src/test/java/ml/comet/experiment/impl/utils/CometUtilsTest.java b/comet-java-client/src/test/java/ml/comet/experiment/impl/utils/CometUtilsTest.java
@@ -4,7 +4,6 @@
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
diff --git a/comet-java-client/src/test/java/ml/comet/experiment/impl/utils/ZipUtilsTest.java b/comet-java-client/src/test/java/ml/comet/experiment/impl/utils/ZipUtilsTest.java
@@ -4,7 +4,6 @@
 import org.junit.jupiter.api.Test;
 
 import java.io.File;
-import java.io.FileInputStream;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
@@ -30,7 +29,7 @@ public void testUnzipToFolder() throws IOException {
         Path tmpDir = Files.createTempDirectory("testUnzipToFolder");
         File modelFile = getFile(MODEL_ZIP_FILE_NAME);
         assertNotNull(modelFile, "model's ZIP file not found");
-        try (ZipInputStream zis = new ZipInputStream(new FileInputStream(modelFile))) {
+        try (ZipInputStream zis = new ZipInputStream(Files.newInputStream(modelFile.toPath()))) {
             int files = ZipUtils.unzipToFolder(zis, tmpDir);
             assertEquals(MODEL_FILES_NUMBER, files, "wrong files number");
             // Check that all files/folders from ZIP was properly deflated

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public interface OnlineExperimentBuilder extends BaseCometBuilder<OnlineExperime`
`34`	`34`	`/**`
`35`	`35`	`* Set the URL of your comet installation.`
`36`	`36`	`*`
`37`		`- * @param urlOverride full url of comet installation. Default is https://www.comet.ml`
	`37`	`+ * @param urlOverride full url of comet installation. Default is https://www.comet.com`
`38`	`38`	`* @return the builder configured with specified URL of the Comet installation.`
`39`	`39`	`*/`
`40`	`40`	`OnlineExperimentBuilder withUrlOverride(String urlOverride);`