IO-323 What should happen in FileUtils.sizeOf[Directory] when an overflow takes place?

sebbASF · sebbASF · commit 6f9e2bbbe326 · 2013-04-16T22:08:05.000Z
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@1468637 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -47,6 +47,10 @@ The <action> type attribute can be add,update,fix,remove.
   <body>
     <!-- The release date is the date RC is cut -->
     <release version="2.5" date="2013-??-??" description="New features and bug fixes.">    
+      <action issue="IO-323" dev="sebb" type="fix">
+        What should happen in FileUtils.sizeOf[Directory] when an overflow takes place?
+        Added Javadoc. 
+      </action>            
       <action issue="IO-372" dev="sebb" type="fix">
         FileUtils.moveDirectory can produce misleading error message on failiure 
       </action>            
diff --git a/src/main/java/org/apache/commons/io/FileUtils.java b/src/main/java/org/apache/commons/io/FileUtils.java
@@ -2448,7 +2448,11 @@ public static void forceMkdirParent(final File file) throws IOException {
      * If the argument is a directory, then the size of the directory is
      * calculated recursively. If a directory or subdirectory is security 
      * restricted, its size will not be included.
-     * 
+     * <p>
+     * Note that overflow is not detected, and the return value may be negative if
+     * overflow occurs. See {@link #sizeOfAsBigInteger(File)} for an alternative
+     * method that does not overflow.
+     *
      * @param file the regular file or directory to return the size 
      *        of (must not be {@code null}).
      * 
@@ -2510,6 +2514,11 @@ public static BigInteger sizeOfAsBigInteger(final File file) {
 
     /**
      * Counts the size of a directory recursively (sum of the length of all files).
+     * <p>
+     * Note that overflow is not detected, and the return value may be negative if
+     * overflow occurs. See {@link #sizeOfDirectoryAsBigInteger(File)} for an alternative
+     * method that does not overflow.
+     *
      * 
      * @param directory
      *            directory to inspect, must not be {@code null}
