Use nio paths instead of strings

src/main/java/edu/ie3/datamodel/io/connectors/CsvFileConnector.java

@@ -20,12 +20,10 @@
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.nio.file.Paths;
 import java.util.*;
 import java.util.function.Function;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
-import org.apache.commons.io.FilenameUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -48,11 +46,11 @@ public class CsvFileConnector implements DataConnector {
       individualTimeSeriesMetaInformation;
 
   private final FileNamingStrategy fileNamingStrategy;
-  private final String baseDirectoryName;
+  private final Path baseDirectoryName;
 
   private static final String FILE_ENDING = ".csv";
 
-  public CsvFileConnector(String baseDirectoryName, FileNamingStrategy fileNamingStrategy) {
+  public CsvFileConnector(Path baseDirectoryName, FileNamingStrategy fileNamingStrategy) {
     this.baseDirectoryName = baseDirectoryName;
     this.fileNamingStrategy = fileNamingStrategy;
   }
@@ -106,22 +104,21 @@ BufferedCsvWriter getOrInitWriter(T timeSeries, String[] headerElements, String
    * @throws ConnectorException If the base folder is a file
    * @throws IOException If the writer cannot be initialized correctly
    */
-  private BufferedCsvWriter initWriter(String baseDirectory, CsvFileDefinition fileDefinition)
+  private BufferedCsvWriter initWriter(Path baseDirectory, CsvFileDefinition fileDefinition)
       throws ConnectorException, IOException {
     /* Join the full DIRECTORY path (excluding file name) */
-    String baseDirectoryHarmonized = IoUtil.harmonizeFileSeparator(baseDirectory);
-    String fullDirectoryPath =
-        FilenameUtils.concat(baseDirectoryHarmonized, fileDefinition.directoryPath());
-    String fullPath = FilenameUtils.concat(baseDirectoryHarmonized, fileDefinition.getFilePath());
+    Path baseDirectoryHarmonized = Path.of(IoUtil.harmonizeFileSeparator(baseDirectory.toString()));
+    Path fullDirectoryPath = baseDirectoryHarmonized.resolve(fileDefinition.directoryPath());
+    Path fullPath = baseDirectoryHarmonized.resolve(fileDefinition.getFilePath());
 
     /* Create missing directories */
-    File directories = new File(fullDirectoryPath);
+    File directories = fullDirectoryPath.toFile();
     if (directories.isFile())
       throw new ConnectorException("Directory '" + directories + "' already exists and is a file!");
     if (!directories.exists() && !directories.mkdirs())
       throw new IOException("Unable to create directory tree '" + directories + "'");
 
-    File pathFile = new File(fullPath);
+    File pathFile = fullPath.toFile();
     boolean append = pathFile.exists();
     BufferedCsvWriter writer =
         new BufferedCsvWriter(
@@ -182,7 +179,7 @@ public synchronized <C extends UniqueEntity> void closeEntityWriter(Class<C> clz
    * @throws FileNotFoundException If the matching file cannot be found
    */
   public BufferedReader initReader(Class<? extends UniqueEntity> clz) throws FileNotFoundException {
-    String filePath = null;
+    Path filePath = null;
     try {
       filePath =
           fileNamingStrategy
@@ -210,8 +207,8 @@ public BufferedReader initReader(Class<? extends UniqueEntity> clz) throws FileN
    * @return the reader that contains information about the file to be read in
    * @throws FileNotFoundException if no file with the provided file name can be found
    */
-  public BufferedReader initReader(String filePath) throws FileNotFoundException {
-    File fullPath = new File(baseDirectoryName + File.separator + filePath + FILE_ENDING);
+  public BufferedReader initReader(Path filePath) throws FileNotFoundException {
+    File fullPath = baseDirectoryName.resolve(filePath).resolve(FILE_ENDING).toFile();
     return new BufferedReader(
         new InputStreamReader(new FileInputStream(fullPath), StandardCharsets.UTF_8), 16384);
   }
@@ -252,9 +249,10 @@ public BufferedReader initReader(String filePath) throws FileNotFoundException {
             filePath -> {
               /* Extract meta information from file path and enhance it with the file path itself */
               IndividualTimeSeriesMetaInformation metaInformation =
-                  fileNamingStrategy.individualTimeSeriesMetaInformation(filePath);
+                  fileNamingStrategy.individualTimeSeriesMetaInformation(filePath.toString());
               return new edu.ie3.datamodel.io.csv.CsvIndividualTimeSeriesMetaInformation(
-                  metaInformation, FileNamingStrategy.removeFileNameEnding(filePath));
+                  metaInformation,
+                  Path.of(FileNamingStrategy.removeFileNameEnding(filePath.toString())));
             })
         .filter(
             metaInformation ->
@@ -271,23 +269,20 @@ public BufferedReader initReader(String filePath) throws FileNotFoundException {
    *
    * @return A set of relative paths to time series files, with respect to the base folder path
    */
-  private Set<String> getIndividualTimeSeriesFilePaths() {
-    Path baseDirectoryPath =
-        Paths.get(
-            FilenameUtils.getFullPath(baseDirectoryName)
-                + FilenameUtils.getName(baseDirectoryName));
+  private Set<Path> getIndividualTimeSeriesFilePaths() {
+    Path baseDirectoryPath = baseDirectoryName.resolve(baseDirectoryName);
     try (Stream<Path> pathStream = Files.walk(baseDirectoryPath)) {
       return pathStream
           .map(baseDirectoryPath::relativize)
           .filter(
               path -> {
-                String withoutEnding = FileNamingStrategy.removeFileNameEnding(path.toString());
+                Path withoutEnding =
+                    Path.of(FileNamingStrategy.removeFileNameEnding(path.toString()));
                 return fileNamingStrategy
                     .getIndividualTimeSeriesPattern()
-                    .matcher(withoutEnding)
+                    .matcher(withoutEnding.toString())
                     .matches();
               })
-          .map(Path::toString)
           .collect(Collectors.toSet());
     } catch (IOException e) {
       log.error("Unable to determine time series files readers for time series.", e);
@@ -303,7 +298,7 @@ private Set<String> getIndividualTimeSeriesFilePaths() {
    * @throws FileNotFoundException If the file is not present
    */
   public BufferedReader initIdCoordinateReader() throws FileNotFoundException {
-    String filePath = fileNamingStrategy.getIdCoordinateEntityName();
+    Path filePath = Path.of(fileNamingStrategy.getIdCoordinateEntityName());
     return initReader(filePath);
   }
 
@@ -319,7 +314,7 @@ public BufferedReader initIdCoordinateReader() throws FileNotFoundException {
   private <T extends TimeSeries<E, V>, E extends TimeSeriesEntry<V>, V extends Value>
       CsvFileDefinition buildFileDefinition(T timeSeries, String[] headLineElements, String csvSep)
           throws ConnectorException {
-    String directoryPath = fileNamingStrategy.getDirectoryPath(timeSeries).orElse("");
+    Path directoryPath = fileNamingStrategy.getDirectoryPath(timeSeries).orElse(Path.of(""));
     String fileName =
         fileNamingStrategy
             .getEntityName(timeSeries)
@@ -342,7 +337,7 @@ CsvFileDefinition buildFileDefinition(T timeSeries, String[] headLineElements, S
   private CsvFileDefinition buildFileDefinition(
       Class<? extends UniqueEntity> clz, String[] headLineElements, String csvSep)
       throws ConnectorException {
-    String directoryPath = fileNamingStrategy.getDirectoryPath(clz).orElse("");
+    Path directoryPath = fileNamingStrategy.getDirectoryPath(clz).orElse(Path.of(""));
     String fileName =
         fileNamingStrategy
             .getEntityName(clz)
@@ -376,23 +371,23 @@ public void shutdown() {
   @Deprecated(since = "3.0", forRemoval = true)
   public static class CsvIndividualTimeSeriesMetaInformation
       extends edu.ie3.datamodel.io.csv.timeseries.IndividualTimeSeriesMetaInformation {
-    private final String fullFilePath;
+    private final Path fullFilePath;
 
     public CsvIndividualTimeSeriesMetaInformation(
         UUID uuid,
         edu.ie3.datamodel.io.csv.timeseries.ColumnScheme columnScheme,
-        String fullFilePath) {
+        Path fullFilePath) {
       super(uuid, columnScheme);
       this.fullFilePath = fullFilePath;
     }
 
     public CsvIndividualTimeSeriesMetaInformation(
         edu.ie3.datamodel.io.csv.timeseries.IndividualTimeSeriesMetaInformation metaInformation,
-        String fullFilePath) {
+        Path fullFilePath) {
       this(metaInformation.getUuid(), metaInformation.getColumnScheme(), fullFilePath);
     }
 
-    public String getFullFilePath() {
+    public Path getFullFilePath() {
       return fullFilePath;
     }
 

src/main/java/edu/ie3/datamodel/io/csv/BufferedCsvWriter.java

@@ -9,6 +9,7 @@
 import edu.ie3.util.StringUtils;
 import java.io.*;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.Path;
 import java.util.Arrays;
 import java.util.Map;
 import java.util.Objects;
@@ -39,10 +40,11 @@ public class BufferedCsvWriter extends BufferedWriter {
    *     if no file exists, a new one will be created in both cases
    * @throws IOException If the FileOutputStream cannot be established.
    */
-  public BufferedCsvWriter(
-      String filePath, String[] headLineElements, String csvSep, boolean append)
+  public BufferedCsvWriter(Path filePath, String[] headLineElements, String csvSep, boolean append)
       throws IOException {
-    super(new OutputStreamWriter(new FileOutputStream(filePath, append), StandardCharsets.UTF_8));
+    super(
+        new OutputStreamWriter(
+            new FileOutputStream(filePath.toFile(), append), StandardCharsets.UTF_8));
     this.headLineElements = headLineElements;
     this.csvSep = csvSep;
   }
@@ -59,10 +61,10 @@ public BufferedCsvWriter(
    *     if no file exists, a new one will be created in both cases
    * @throws IOException If the FileOutputStream cannot be established.
    */
-  public BufferedCsvWriter(String baseFolder, CsvFileDefinition fileDefinition, boolean append)
+  public BufferedCsvWriter(Path baseFolder, CsvFileDefinition fileDefinition, boolean append)
       throws IOException {
     this(
-        baseFolder + File.separator + fileDefinition.getFilePath(),
+        baseFolder.resolve(fileDefinition.getFilePath()),
         fileDefinition.headLineElements(),
         fileDefinition.csvSep(),
         append);

src/main/java/edu/ie3/datamodel/io/csv/CsvFileDefinition.java

@@ -6,16 +6,17 @@
 package edu.ie3.datamodel.io.csv;
 
 import edu.ie3.datamodel.io.IoUtil;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.Arrays;
 import java.util.Objects;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
-import org.apache.commons.io.FilenameUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 public record CsvFileDefinition(
-    String fileName, String directoryPath, String[] headLineElements, String csvSep) {
+    String fileName, Path directoryPath, String[] headLineElements, String csvSep) {
   private static final Logger logger = LoggerFactory.getLogger(CsvFileDefinition.class);
 
   private static final Pattern FILE_NAME_PATTERN =
@@ -25,15 +26,17 @@ public record CsvFileDefinition(
   private static final String FILE_EXTENSION = "csv";
 
   public CsvFileDefinition(
-      String fileName, String directoryPath, String[] headLineElements, String csvSep) {
+      String fileName, Path directoryPath, String[] headLineElements, String csvSep) {
     /* Remove all file separators at the beginning and end of a directory path and ensure harmonized file separator */
     this.directoryPath =
-        Objects.nonNull(directoryPath)
-            ? IoUtil.harmonizeFileSeparator(
-                directoryPath
-                    .replaceFirst("^" + IoUtil.FILE_SEPARATOR_REGEX, "")
-                    .replaceAll(IoUtil.FILE_SEPARATOR_REGEX + "$", ""))
-            : "";
+        Path.of(
+            Objects.nonNull(directoryPath)
+                ? IoUtil.harmonizeFileSeparator(
+                    directoryPath
+                        .toString()
+                        .replaceFirst("^" + IoUtil.FILE_SEPARATOR_REGEX, "")
+                        .replaceAll(IoUtil.FILE_SEPARATOR_REGEX + "$", ""))
+                : "");
 
     /* Check the given information of the file name */
     Matcher matcher = FILE_NAME_PATTERN.matcher(fileName);
@@ -58,7 +61,7 @@ public CsvFileDefinition(
 
   /** @deprecated since 3.0. Use {@link #directoryPath()} instead */
   @Deprecated(since = "3.0")
-  public String getDirectoryPath() {
+  public Path getDirectoryPath() {
     return directoryPath;
   }
 
@@ -75,8 +78,8 @@ public String getFileName() {
    * @return The path to the file relative to a not explicitly defined base directory, including the
    *     file extension
    */
-  public String getFilePath() {
-    return !directoryPath.isEmpty() ? FilenameUtils.concat(directoryPath, fileName) : fileName;
+  public Path getFilePath() {
+    return Files.exists(directoryPath) ? directoryPath.resolve(fileName) : Path.of(fileName);
   }
 
   /** @deprecated since 3.0. Use {@link #headLineElements()} instead */

src/main/java/edu/ie3/datamodel/io/csv/CsvIndividualTimeSeriesMetaInformation.java

@@ -7,25 +7,26 @@
 
 import edu.ie3.datamodel.io.naming.timeseries.ColumnScheme;
 import edu.ie3.datamodel.io.naming.timeseries.IndividualTimeSeriesMetaInformation;
+import java.nio.file.Path;
 import java.util.Objects;
 import java.util.UUID;
 
 /** Enhancing the {@link IndividualTimeSeriesMetaInformation} with the full path to csv file */
 public class CsvIndividualTimeSeriesMetaInformation extends IndividualTimeSeriesMetaInformation {
-  private final String fullFilePath;
+  private final Path fullFilePath;
 
   public CsvIndividualTimeSeriesMetaInformation(
-      UUID uuid, ColumnScheme columnScheme, String fullFilePath) {
+      UUID uuid, ColumnScheme columnScheme, Path fullFilePath) {
     super(uuid, columnScheme);
     this.fullFilePath = fullFilePath;
   }
 
   public CsvIndividualTimeSeriesMetaInformation(
-      IndividualTimeSeriesMetaInformation metaInformation, String fullFilePath) {
+      IndividualTimeSeriesMetaInformation metaInformation, Path fullFilePath) {
     this(metaInformation.getUuid(), metaInformation.getColumnScheme(), fullFilePath);
   }
 
-  public String getFullFilePath() {
+  public Path getFullFilePath() {
     return fullFilePath;
   }