Add org.apache.commons.io.file.PathUtils.getPath(String, String)

Author: garydgregory

src/changes/changes.xml

@@ -62,6 +62,7 @@ The <action> type attribute can be add,update,fix,remove.
       <action dev="ggregory" type="add"                due-to="Gary Gregory">Add org.apache.commons.io.output.ProxyOutputStream.writeRepeat(int, long).</action>
       <action dev="pkarwasz" type="add"                due-to="Piotr P. Karwasz">Add length unit support in FileSystem limits.</action>
       <action dev="pkarwasz" type="add"                due-to="Piotr P. Karwasz">Add IOUtils.toByteArray(InputStream, int, int) for safer chunked reading with size validation.</action>
+      <action dev="pkarwasz" type="add"                due-to="Piotr P. Karwasz">Add org.apache.commons.io.file.PathUtils.getPath(String, String).</action>
       <!-- UPDATE -->
       <action type="update" dev="ggregory"             due-to="Gary Gregory, Dependabot">Bump org.apache.commons:commons-parent from 85 to 87 #774.</action>
       <action type="update" dev="ggregory"             due-to="Gary Gregory">[test] Bump commons-codec:commons-codec from 1.18.0 to 1.19.0.</action>

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

@@ -1096,6 +1096,19 @@ private static Path getParent(final Path path) {
         return path == null ? null : path.getParent();
     }
 
+    /**
+     * Gets the system property with the specified name as a Path, or the default value as a Path if there is no property with that key.
+     *
+     * @param key the name of the system property.
+     * @param defaultPath a default path, may be null.
+     * @return the resulting {@code Path}, or the default value as a Path if there is no property with that key.
+     * @since 2.21.0
+     */
+    public static Path getPath(final String key, final String defaultPath) {
+        final String property = System.getProperty(Objects.toString(key, defaultPath), defaultPath);
+        return property != null ? Paths.get(property) : null;
+    }
+
     /**
      * Shorthand for {@code Files.getFileAttributeView(path, PosixFileAttributeView.class)}.
      *

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

@@ -351,6 +351,18 @@ void testGetLastModifiedFileTime_URL_Present() throws IOException, URISyntaxExce
         assertNotNull(PathUtils.getLastModifiedFileTime(current().toUri().toURL()));
     }
 
+    @Test
+    void testGetPath() {
+        final String validKey = "user.dir";
+        final Path value = Paths.get(System.getProperty(validKey));
+        assertEquals(value, PathUtils.getPath(validKey, null));
+        assertEquals(value, PathUtils.getPath(validKey, validKey));
+        final String invalidKey = "this property key does not exist";
+        assertEquals(value, PathUtils.getPath(invalidKey, value.toString()));
+        assertNull(PathUtils.getPath(invalidKey, null));
+        assertEquals(value, PathUtils.getPath(null, value.toString()));
+    }
+
     @Test
     void testGetTempDirectory() {
         final Path tempDirectory = Paths.get(SystemProperties.getJavaIoTmpdir());

src/test/java/org/apache/commons/io/filefilter/AbstractConditionalFileFilterTest.java

@@ -60,7 +60,7 @@ public abstract class AbstractConditionalFileFilterTest extends AbstractIOFileFi
 
     @BeforeEach
     public void setUp() {
-        this.workingPath = determineWorkingDirectoryPath(getWorkingPathNamePropertyKey(), getDefaultWorkingPath());
+        this.workingPath = getWorkingDirectoryPath(getWorkingPathNamePropertyKey(), getDefaultWorkingPath());
         this.file = new File(this.workingPath, TEST_FILE_NAME_PREFIX + 1 + TEST_FILE_TYPE);
         this.trueFilters = new TesterTrueFileFilter[4];
         this.falseFilters = new TesterFalseFileFilter[4];

src/test/java/org/apache/commons/io/filefilter/AbstractIOFileFilterTest.java

@@ -22,6 +22,8 @@
 import java.util.Objects;
 import java.util.stream.Stream;
 
+import org.apache.commons.io.file.PathUtils;
+
 public abstract class AbstractIOFileFilterTest {
 
     final class TesterFalseFileFilter extends FalseFileFilter {
@@ -125,10 +127,9 @@ public static void assertTrueFiltersInvoked(final int testNumber, final TesterTr
         }
     }
 
-    public static File determineWorkingDirectoryPath(final String key, final String defaultPath) {
+    public static File getWorkingDirectoryPath(final String key, final String defaultPath) {
         // Look for a system property to specify the working directory
-        final String workingPathName = System.getProperty(key, defaultPath);
-        return new File(workingPathName);
+        return PathUtils.getPath(key, defaultPath).toFile();
     }
 
     public static void resetFalseFilters(final TesterFalseFileFilter[] filters) {