Merge remote-tracking branch 'upstream/master'

Author: garydgregory

.github/workflows/codeql-analysis.yml

@@ -63,7 +63,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@9e907b5e64f6b83e7804b09294d44122997950d6 # v4.32.3
+      uses: github/codeql-action/init@c6f931105cb2c34c8f901cc885ba1e2e259cf745 # v4.34.0
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -74,7 +74,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@9e907b5e64f6b83e7804b09294d44122997950d6 # v4.32.3
+      uses: github/codeql-action/autobuild@c6f931105cb2c34c8f901cc885ba1e2e259cf745 # v4.34.0
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -88,4 +88,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@9e907b5e64f6b83e7804b09294d44122997950d6 # v4.32.3
+      uses: github/codeql-action/analyze@c6f931105cb2c34c8f901cc885ba1e2e259cf745 # v4.34.0

.github/workflows/scorecards-analysis.yml

@@ -59,13 +59,13 @@ jobs:
           publish_results: true
 
       - name: "Upload artifact"
-        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f    # 6.0.0
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
         with:
           name: SARIF file
           path: results.sarif
           retention-days: 5
 
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@9e907b5e64f6b83e7804b09294d44122997950d6 # v4.32.3
+        uses: github/codeql-action/upload-sarif@c6f931105cb2c34c8f901cc885ba1e2e259cf745 # v4.34.0
         with:
           sarif_file: results.sarif

pom.xml

@@ -19,7 +19,7 @@
   <parent>
     <groupId>org.apache.commons</groupId>
     <artifactId>commons-parent</artifactId>
-    <version>96</version>
+    <version>97</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
   <groupId>commons-io</groupId>
@@ -132,7 +132,7 @@ file comparators, endian transformation classes, and much more.
     </commons.osgi.import>
     <commons.scmPubUrl>https://svn.apache.org/repos/infra/websites/production/commons/content/proper/commons-io/</commons.scmPubUrl>
     <commons.scmPubCheckoutDirectory>site-content</commons.scmPubCheckoutDirectory>
-    <commons.bytebuddy.version>1.18.4</commons.bytebuddy.version>
+    <commons.bytebuddy.version>1.18.7</commons.bytebuddy.version>
     <japicmp.skip>false</japicmp.skip>
     <commons.release.isDistModule>true</commons.release.isDistModule>
     <!-- JaCoCo: Don't make code coverage worse than: -->

src/changes/changes.xml

@@ -60,13 +60,20 @@ The <action> type attribute can be add,update,fix,remove.
       <action type="fix" dev="ggregory" due-to="Gary Gregory">All thread names are now prefixed with "commons-io-".</action>
       <action type="fix" dev="ggregory" due-to="Kishor, Mashrur Mia" issue="IO-639">ReversedLinesFileReader does not read first line if its empty #829.</action>
       <action type="fix" dev="ggregory" due-to="Peter De Maeyer" issue="IO-886">Fixed incorrect regular expression in PathUtils.RelativeSortedPaths.extractKey(String, String).</action>
-      
+      <action type="fix" dev="ggregory" due-to="Martin Wiesner">Fix typos in Javadoc of FileUtils and related test classes #833.</action>
+      <action type="fix" dev="ggregory" due-to="Daniel Vega, Gary Gregory" issue="IO-887">WriterOutputStream from a builder fails on malformed or unmappable input bytes.</action>
+      <action type="fix" dev="ggregory" due-to="Gary Gregory">BoundedReader now extends ProxyReader.</action>
       <!-- ADD -->
       <action type="add" dev="ggregory" due-to="Gary Gregory, Piotr P. Karwasz">Add and use IOUtils.closeQuietlySuppress(Closeable, Throwable) #818.</action>
+      <action type="add" dev="ggregory" due-to="Gary Gregory">Add ProxyWriter.setReference(Writer).</action>
+      <action type="add" dev="ggregory" due-to="Gary Gregory">Add ProxyWriter.unwrap().</action>
+      <action type="add" dev="ggregory" due-to="Gary Gregory">Add ProxyReader.setReference(Reader).</action>
+      <action type="add" dev="ggregory" due-to="Gary Gregory">Add ProxyReader.unrwap().</action>
+      <action type="add" dev="ggregory" due-to="Gary Gregory">Make ProxyOutputStream.unrwap() public.</action>
       <!-- UPDATE -->
-      <action type="update" dev="ggregory"             due-to="Gary Gregory, Dependabot">Bump org.apache.commons:commons-parent from 91 to 96 #816.</action>
+      <action type="update" dev="ggregory"             due-to="Gary Gregory, Dependabot">Bump org.apache.commons:commons-parent from 91 to 97 #816.</action>
       <action type="update" dev="ggregory"             due-to="Gary Gregory, Dependabot">Bump commons-codec:commons-codec from 1.19.0 to 1.21.0 #812.</action>
-      <action type="update" dev="ggregory"             due-to="Gary Gregory, Dependabot">Bump commons.bytebuddy.version from 1.17.8 to 1.18.4 #814, #820.</action>
+      <action type="update" dev="ggregory"             due-to="Gary Gregory, Dependabot">Bump commons.bytebuddy.version from 1.17.8 to 1.18.7 #814, #820.</action>
       <action type="update" dev="ggregory"             due-to="Gary Gregory, Dependabot">Bump commons-lang3 from 3.19.0 to 3.20.0.</action>      
     </release>
     <release version="2.21.0" date="2025-11-04" description="Version 2.21.0: Java 8 or later is required.">

src/main/java/org/apache/commons/io/FileSystem.java

@@ -32,11 +32,10 @@
 import java.util.Objects;
 
 /**
- * Abstracts an OS' file system details, currently supporting the single use case of converting a file name String to a
- * legal file name with {@link #toLegalFileName(String, char)}.
+ * Enumerates file system details for operating systems, currently supporting the single use case of converting a file name String to a legal file name with
+ * {@link #toLegalFileName(String, char)}.
  * <p>
- * The starting point of any operation is {@link #getCurrent()} which gets you the enum for the file system that matches
- * the OS hosting the running JVM.
+ * The starting point of any operation is {@link #getCurrent()} which gets you the enum for the file system that matches the OS hosting the running JVM.
  * </p>
  *
  * @since 2.7

src/main/java/org/apache/commons/io/FileUtils.java

@@ -1555,7 +1555,7 @@ public static File getTempDirectory() {
      * WARNING: 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 File}
+     * than the standard library methods in classes such as {@link File}
      *
      * @return the path to the system temporary directory as a String.
      * @since 2.0

src/main/java/org/apache/commons/io/FilenameUtils.java

@@ -1556,8 +1556,8 @@ private static char toSeparator(final boolean unixSeparator) {
      * </pre>
      * The sequence "*?" does not work properly at present in match strings.
      *
-     * @param fileName  the file name to match on.
-     * @param wildcardMatcher  the wildcard string to match against.
+     * @param fileName  the file name to match on, may be null.
+     * @param wildcardMatcher  the wildcard string to match against, may be null.
      * @return true if the file name matches the wildcard string.
      * @see IOCase#SENSITIVE
      */
@@ -1573,8 +1573,8 @@ public static boolean wildcardMatch(final String fileName, final String wildcard
      * single or multiple (zero or more) wildcard characters.
      * The sequence "*?" does not work properly at present in match strings.
      *
-     * @param fileName  the file name to match on.
-     * @param wildcardMatcher  the wildcard string to match against.
+     * @param fileName  the file name to match on, may be null.
+     * @param wildcardMatcher  the wildcard string to match against, may be null.
      * @param ioCase  what case sensitivity rule to use, null means case-sensitive.
      * @return true if the file name matches the wildcard string.
      * @since 1.3

src/main/java/org/apache/commons/io/IOCase.java

@@ -21,7 +21,7 @@
 import java.util.stream.Stream;
 
 /**
- * Enumeration of IO case sensitivity.
+ * Enumerates IO case sensitivity types.
  * <p>
  * Different filing systems have different rules for case-sensitivity.
  * Windows is case-insensitive, Unix is case-sensitive.
@@ -95,7 +95,7 @@ public static boolean isCaseSensitive(final IOCase ioCase) {
     /**
      * Returns the given value if not-null, the defaultValue if null.
      *
-     * @param value the value to test.
+     * @param value the value to test, may be null.
      * @param defaultValue the default value.
      * @return the given value if not-null, the defaultValue if null.
      * @since 2.12.0

src/main/java/org/apache/commons/io/IOUtils.java

@@ -1803,7 +1803,7 @@ public static long copyLarge(final InputStream input, final OutputStream output,
             output.write(buffer, 0, read);
             totalRead += read;
             if (length > 0) { // only adjust length if not reading to the end
-                // Note the cast must work because buffer.length is an integer
+                // Note the cast must work because bufferLength = buffer.length is an integer
                 bytesToRead = (int) Math.min(length - totalRead, bufferLength);
             }
         }

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

@@ -22,7 +22,7 @@
 import org.apache.commons.io.IOUtils;
 
 /**
- * Defines the standard delete options.
+ * Enumerates the standard delete options.
  *
  * @since 2.8.0
  */