Fixing issue with javadoc

adobe · May 28, 2024 · 5bb23de · 5bb23de
1 parent de09447
commit 5bb23de
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 8 deletions.
diff --git a/src/main/java/com/adobe/campaign/tests/logparser/utils/CSVManager.java b/src/main/java/com/adobe/campaign/tests/logparser/utils/CSVManager.java
@@ -20,7 +20,6 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Set;
 import java.util.stream.Collectors;
 
 public class CSVManager {
@@ -31,13 +30,13 @@ public class CSVManager {
      * <p>
      * Author : gandomi
      *
-     * @param in_fileToLoad
-     * @param in_key
+     * @param in_fileToLoad A file to fetch
+     * @param in_key The header key to use as the key in the map
      * @return A map with the key being the LogDataKey and the values stored for that LogEntry
      * @throws FileNotFoundException if the file is absent
-     * @throws IOException
+     * @throws IOException if the file cannot be read
      */
-    public static Map<String, List<String>> fetchCoverageHistoryData(final String in_key,
+    public static Map<String, List<String>> fetchCSVToMapList(final String in_key,
             final File in_fileToLoad) throws FileNotFoundException, IOException {
 
         Map<String, List<String>> l_coverageHistory = new HashMap<String, List<String>>();

diff --git a/src/test/java/com/adobe/campaign/tests/logparser/core/LogDataTest.java b/src/test/java/com/adobe/campaign/tests/logparser/core/LogDataTest.java
@@ -1368,7 +1368,7 @@ public void testExportData()
             assertThat("We successfully created the file correctly", l_exportedFile.getName(),
                     Matchers.endsWith(l_fileNameToExpect + "-export.csv"));
 
-            Map<String, List<String>> l_fetchedResult = CSVManager.fetchCoverageHistoryData(StdLogEntry.STD_DATA_KEY,
+            Map<String, List<String>> l_fetchedResult = CSVManager.fetchCSVToMapList(StdLogEntry.STD_DATA_KEY,
                     l_exportedFile);
 
             for (GenericEntry l_ge : l_logData.getEntries().values()) {
@@ -1415,7 +1415,7 @@ public void testExportDataFileExists()
             assertThat("We successfully created the file correctly", l_exportedFile.getName(),
                     Matchers.endsWith(l_fileNameToExpect));
 
-            Map<String, List<String>> l_fetchedResult = CSVManager.fetchCoverageHistoryData(StdLogEntry.STD_DATA_KEY,
+            Map<String, List<String>> l_fetchedResult = CSVManager.fetchCSVToMapList(StdLogEntry.STD_DATA_KEY,
                     l_exportedFile);
 
             for (GenericEntry l_ge : l_logData.getEntries().values()) {

diff --git a/src/test/java/com/adobe/campaign/tests/logparser/utils/CSVManagerTest.java b/src/test/java/com/adobe/campaign/tests/logparser/utils/CSVManagerTest.java
@@ -35,7 +35,7 @@ public void fetchCoverageHistoryData_noFile() throws IOException {
 
         final File l_csvFile = new File(faker.file().fileName());
         Map<String, List<String>> l_coverageHistory = csvManager
-                .fetchCoverageHistoryData(faker.name().firstName(), l_csvFile);
+                .fetchCSVToMapList(faker.name().firstName(), l_csvFile);
 
         assertThat("We should have an empty map", l_coverageHistory.isEmpty());