[commons-io] branch master updated: Note re getTempDirectoryPath trailing separator

[sebb]

This is an automated email from the ASF dual-hosted git repository.

sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git


The following commit(s) were added to refs/heads/master by this push:
     new f237c712 Note re getTempDirectoryPath trailing separator
f237c712 is described below

commit f237c712492f4dc08b1e93b56cb1fe54c76b671f
Author: Sebb <s...@apache.org>
AuthorDate: Thu Oct 19 17:42:56 2023 +0100

    Note re getTempDirectoryPath trailing separator
---
 src/main/java/org/apache/commons/io/FileUtils.java | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/commons/io/FileUtils.java 
b/src/main/java/org/apache/commons/io/FileUtils.java
index 72114323..4c1c5658 100644
--- a/src/main/java/org/apache/commons/io/FileUtils.java
+++ b/src/main/java/org/apache/commons/io/FileUtils.java
@@ -1445,7 +1445,7 @@ public class FileUtils {
     /**
      * Returns a {@link File} representing the system temporary directory.
      *
-     * @return the system temporary directory.
+     * @return the system temporary directory as a File
      * @since 2.0
      */
     public static File getTempDirectory() {
@@ -1455,7 +1455,12 @@ public class FileUtils {
     /**
      * Returns the path to the system temporary directory.
      *
-     * @return the path to the system temporary directory.
+     * @apiNote this method relies on the Java system property 
'java.io.tmpdir' 
+     * which may or may not have a trailing file separator.
+     * This can affect code that uses String processing to manipulate 
pathnames rather
+     * than the standard libary methods in classes such as {@link java.io.File}
+     *
+     * @return the path to the system temporary directory as a String
      * @since 2.0
      */
     public static String getTempDirectoryPath() {