Add PathUtils.readString(Path, Charset).

Author: Gary Gregory

src/changes/changes.xml

@@ -105,6 +105,9 @@ The <action> type attribute can be add,update,fix,remove.
       <action dev="ggregory" type="add" due-to="Gary Gregory">
         Add NullReader.INSTANCE.
       </action>
+      <action dev="ggregory" type="add" due-to="Gary Gregory">
+        Add PathUtils.readString(Path, Charset).
+      </action>
       <!-- UPDATE -->
       <action dev="ggregory" type="update" due-to="Dependabot">
         Bump Maven Javadoc plugin from 3.2.0 to 3.3.0.

src/main/java/org/apache/commons/io/file/PathUtils.java

@@ -23,6 +23,7 @@
 import java.io.UncheckedIOException;
 import java.net.URI;
 import java.net.URL;
+import java.nio.charset.Charset;
 import java.nio.file.CopyOption;
 import java.nio.file.DirectoryStream;
 import java.nio.file.FileVisitOption;
@@ -56,6 +57,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import org.apache.commons.io.Charsets;
 import org.apache.commons.io.IOExceptionList;
 import org.apache.commons.io.IOUtils;
 import org.apache.commons.io.file.Counters.PathCounters;
@@ -873,6 +875,20 @@ public static BasicFileAttributes readBasicFileAttributesUnchecked(final Path pa
         }
     }
 
+    /**
+     * Reads the given path as a String.
+     *
+     * @param path The source path.
+     * @param charset How to convert bytes to a String.
+     * @return a new String
+     * @throws IOException if an I/O error occurs reading from the stream
+     * @see Files#readAllBytes(Path)
+     * @since 2.12.0
+     */
+    public static Object readString(final Path path, final Charset charset) throws IOException {
+        return new String(Files.readAllBytes(path), Charsets.toCharset(charset));
+    }
+
     /**
      * Relativizes all files in the given {@code collection} against a {@code parent}.
      *

src/test/java/org/apache/commons/io/file/PathUtilsTest.java

@@ -23,6 +23,7 @@
 
 import java.io.IOException;
 import java.net.URI;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.DirectoryStream;
 import java.nio.file.FileSystem;
 import java.nio.file.FileSystems;
@@ -34,6 +35,7 @@
 import java.util.Map;
 
 import org.apache.commons.io.filefilter.NameFileFilter;
+import org.apache.commons.lang3.StringUtils;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 
@@ -218,4 +220,19 @@ public void testNewDirectoryStream() throws Exception {
         }
     }
 
+    @Test
+    public void testReadStringEmptyFile() throws IOException {
+        final Path path = Paths.get("src/test/resources/org/apache/commons/io/test-file-empty.bin");
+        assertEquals(StringUtils.EMPTY, PathUtils.readString(path, StandardCharsets.UTF_8));
+        assertEquals(StringUtils.EMPTY, PathUtils.readString(path, null));
+    }
+
+    @Test
+    public void testReadStringSimpleUtf8() throws IOException {
+        final Path path = Paths.get("src/test/resources/org/apache/commons/io/test-file-simple-utf8.bin");
+        final String expected = "ABC\r\n";
+        assertEquals(expected, PathUtils.readString(path, StandardCharsets.UTF_8));
+        assertEquals(expected, PathUtils.readString(path, null));
+    }
+
 }