Refactor File I/O handling (#874)

* Changed all references to java.io.File to use equivalent java.nio.Path or java.nio.Files methods and types

---------

Co-authored-by: Brad Hall <bradley.hall@fullsight.org>

Author: concurrent-recursion

litiengine/src/main/java/de/gurkenlabs/litiengine/GameLog.java

@@ -1,6 +1,7 @@
 package de.gurkenlabs.litiengine;
 
-import java.io.File;
+import java.nio.file.Files;
+import java.nio.file.Paths;
 import java.util.logging.ConsoleHandler;
 import java.util.logging.FileHandler;
 import java.util.logging.Level;
@@ -26,7 +27,7 @@ Logger log() {
 
   void init() {
     LogManager.getLogManager().reset();
-    if (new File(LOGGING_CONFIG_FILE).exists()) {
+    if (Files.exists(Paths.get(LOGGING_CONFIG_FILE))) {
       System.setProperty("java.util.logging.config.file", LOGGING_CONFIG_FILE);
 
       try {

litiengine/src/main/java/de/gurkenlabs/litiengine/configuration/Configuration.java

@@ -2,13 +2,15 @@
 
 import de.gurkenlabs.litiengine.Game;
 import de.gurkenlabs.litiengine.resources.Resources;
+
 import java.io.BufferedInputStream;
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.nio.file.StandardOpenOption;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Properties;
@@ -122,10 +124,10 @@ public String getFileName() {
    * exists, it creates a new configuration file in the application folder.
    */
   public void load() {
-    final File settingsFile = new File(this.getFileName());
+    final Path settingsFile = Paths.get(this.getFileName());
     try (InputStream settingsStream = Resources.get(this.getFileName())) {
-      if (!settingsFile.exists() && settingsStream == null || !settingsFile.isFile()) {
-        try (OutputStream out = new FileOutputStream(settingsFile)) {
+      if (!Files.exists(settingsFile) && settingsStream == null || !Files.isRegularFile(settingsFile)) {
+        try (OutputStream out = Files.newOutputStream(settingsFile)) {
           this.createDefaultSettingsFile(out);
         }
 
@@ -136,8 +138,8 @@ public void load() {
       log.log(Level.SEVERE, e.getMessage(), e);
     }
 
-    if (settingsFile.exists()) {
-      try (InputStream settingsStream = new FileInputStream(settingsFile)) {
+    if (Files.exists(settingsFile)) {
+      try (InputStream settingsStream = Files.newInputStream(settingsFile)) {
 
         final Properties properties = new Properties();
         BufferedInputStream stream;
@@ -161,8 +163,8 @@ public void load() {
    * @see Configuration#DEFAULT_CONFIGURATION_FILE_NAME
    */
   public void save() {
-    final File settingsFile = new File(this.getFileName());
-    try (OutputStream out = new FileOutputStream(settingsFile, false)) {
+    final Path settingsFile = Paths.get(this.getFileName());
+    try (OutputStream out = Files.newOutputStream(settingsFile, StandardOpenOption.CREATE_NEW)) {
       for (final ConfigurationGroup group : this.getConfigurationGroups()) {
         if (!Game.isDebug() && group.isDebug()) {
           continue;

litiengine/src/main/java/de/gurkenlabs/litiengine/graphics/RenderComponent.java

@@ -5,6 +5,7 @@
 import de.gurkenlabs.litiengine.resources.ImageFormat;
 import de.gurkenlabs.litiengine.util.TimeUtilities;
 import de.gurkenlabs.litiengine.util.io.ImageSerializer;
+
 import java.awt.Canvas;
 import java.awt.Color;
 import java.awt.Dimension;
@@ -15,19 +16,25 @@
 import java.awt.Toolkit;
 import java.awt.image.BufferStrategy;
 import java.awt.image.BufferedImage;
-import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.text.SimpleDateFormat;
 import java.util.Date;
 import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.function.Consumer;
 import java.util.function.IntConsumer;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 /**
  * The {@code RenderComponent} class extends {@link Canvas} and handles the rendering of the game screen, including managing fade effects, capturing
  * screenshots, and rendering the game cursor.
  */
 public class RenderComponent extends Canvas {
+  private static final Logger log = Logger.getLogger(RenderComponent.class.getName());
   /**
    * The default background color for the rendering component.
    */
@@ -287,13 +294,15 @@ private void updateAlpha(long startTime, int duration, boolean fadeIn) {
   private void saveScreenshot(BufferedImage img) {
     try {
       String timeStamp = new SimpleDateFormat("yyyy-MM-dd-HH-mm-ss").format(new Date());
-      File folder = new File("./screenshots/");
-      if (!folder.exists()) {
-        folder.mkdirs();
+      Path folder = Paths.get("./screenshots/");
+      if (!Files.exists(folder)) {
+        Files.createDirectories(folder);
       }
       String path = "./screenshots/" + timeStamp + ImageFormat.PNG.toFileExtension();
       ImageSerializer.saveImage(path, img);
-    } finally {
+    } catch (final IOException e) {
+      log.log(Level.SEVERE, e.getMessage(), e);
+    } finally{
       takeScreenShot = false;
     }
   }

litiengine/src/main/java/de/gurkenlabs/litiengine/resources/ImageFormat.java

@@ -1,10 +1,10 @@
 package de.gurkenlabs.litiengine.resources;
 
-import java.io.File;
+import java.nio.file.Path;
 
 /**
  * Contains all known image file-formats supported by the engine.
- * 
+ *
  * @see SoundFormat
  */
 public enum ImageFormat {
@@ -16,7 +16,7 @@ public enum ImageFormat {
 
   /**
    * Gets the {@code ImageFormat} of the specified format string.
-   * 
+   *
    * @param imageFormat
    *          The format string from which to extract the format.
    * @return The format of the specified string or {@code UNDEFINED} if not supported.
@@ -27,22 +27,22 @@ public static ImageFormat get(String imageFormat) {
 
   /**
    * Determines whether the extension of the specified file is supported by the engine.
-   * 
+   *
    * @param file
    *          The file to check for.
-   * 
+   *
    * @return True if the extension is part of this enum; otherwise false.
    */
-  public static boolean isSupported(File file) {
+  public static boolean isSupported(Path file) {
     return isSupported(file.toString());
   }
 
   /**
    * Determines whether the extension of the specified file is supported by the engine.
-   * 
+   *
    * @param fileName
    *          The name of the file to check for.
-   * 
+   *
    * @return True if the extension is part of this enum; otherwise false.
    */
   public static boolean isSupported(String fileName) {
@@ -56,7 +56,7 @@ public static String[] getAllExtensions() {
   /**
    * Converts this format instance to a file format string that can be used as an extension (e.g. .png).<br>
    * It adds a leading '.' to the lower-case string representation of this instance.
-   * 
+   *
    * @return The file extension string for this instance.
    */
   public String toFileExtension() {

litiengine/src/main/java/de/gurkenlabs/litiengine/resources/ResourceBundle.java

@@ -17,14 +17,16 @@
 import jakarta.xml.bind.annotation.XmlTransient;
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
-import java.io.File;
-import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.OutputStream;
 import java.io.Serial;
 import java.io.Serializable;
 import java.net.URL;
 import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.nio.file.StandardOpenOption;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
@@ -202,10 +204,10 @@ public String save(final String fileName, final boolean compress) {
       fileNameWithExtension += "." + FILE_EXTENSION;
     }
 
-    final File newFile = new File(fileNameWithExtension);
-    if (newFile.exists()) {
+    final Path newFile = Paths.get(fileNameWithExtension);
+    if (!Files.exists(newFile)) {
       try {
-        Files.delete(newFile.toPath().toAbsolutePath());
+        Files.delete(newFile);
       } catch (IOException e) {
         log.log(Level.WARNING, e.getMessage(), e);
       }
@@ -218,7 +220,7 @@ public String save(final String fileName, final boolean compress) {
     Collections.sort(this.getBluePrints());
     Collections.sort(this.getSounds());
 
-    try (FileOutputStream fileOut = new FileOutputStream(newFile, false)) {
+    try (OutputStream fileOut = Files.newOutputStream(newFile, StandardOpenOption.CREATE_NEW)) {
       final JAXBContext jaxbContext = XmlUtilities.getContext(ResourceBundle.class);
       final Marshaller jaxbMarshaller = jaxbContext.createMarshaller();
       // output pretty printed

litiengine/src/main/java/de/gurkenlabs/litiengine/resources/Resources.java

@@ -11,13 +11,13 @@
 import java.awt.Font;
 import java.awt.image.BufferedImage;
 import java.io.BufferedInputStream;
-import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
@@ -330,7 +330,7 @@ public static URL getLocation(String name) {
       return new URL(name);
     } catch (MalformedURLException e) {
       try {
-        return (new File(name)).toURI().toURL();
+        return (Paths.get(name).toUri().toURL());
       } catch (MalformedURLException e1) {
         return null;
       }

litiengine/src/main/java/de/gurkenlabs/litiengine/resources/SoundFormat.java

@@ -1,6 +1,6 @@
 package de.gurkenlabs.litiengine.resources;
 
-import java.io.File;
+import java.nio.file.Path;
 
 /**
  * Contains all known audio file-formats supported by the engine.
@@ -29,8 +29,8 @@ public static SoundFormat get(String format) {
    * @param file The file to check for.
    * @return True if the extension is part of this enum; otherwise false.
    */
-  public static boolean isSupported(File file) {
-    return isSupported(file.getName());
+  public static boolean isSupported(Path file) {
+    return isSupported(file.getFileName().toString());
   }
 
   /**

litiengine/src/main/java/de/gurkenlabs/litiengine/resources/Spritesheets.java

@@ -9,11 +9,11 @@
 import java.awt.image.BufferedImage;
 import java.io.BufferedReader;
 import java.io.BufferedWriter;
-import java.io.File;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
+import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -281,8 +281,10 @@ public boolean saveTo(final String spriteInfoFile, boolean metadataOnly) {
         writer.write("\n");
 
         if (!metadataOnly) {
-          ImageSerializer.saveImage(Paths.get(new File(spriteInfoFile).getParentFile().getAbsolutePath(),
-              spritesheet.getName() + spritesheet.getImageFormat().toFileExtension()).toString(), spritesheet.getImage(),
+          Path spriteInfoPath = Paths.get(spriteInfoFile);
+          ImageSerializer.saveImage(
+            spriteInfoPath.resolveSibling(spritesheet.getName() + spritesheet.getImageFormat().toFileExtension()).toString(),
+            spritesheet.getImage(),
             spritesheet.getImageFormat());
         }
       }