You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by st...@apache.org on 2017/09/27 21:57:10 UTC
[2/3] commons-io git commit: IO-506: javadoc that freeSpaceKb returns
kibibytes
IO-506: javadoc that freeSpaceKb returns kibibytes
.. not pre-1998 kilobytes -- it was misleadingly named before.
Also fix @deprecated as it is not actually removed in 2.6, just deprecated
Project: http://git-wip-us.apache.org/repos/asf/commons-io/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-io/commit/3af25efa
Tree: http://git-wip-us.apache.org/repos/asf/commons-io/tree/3af25efa
Diff: http://git-wip-us.apache.org/repos/asf/commons-io/diff/3af25efa
Branch: refs/heads/master
Commit: 3af25efa4e252240caac206899f68bdaa20e14ed
Parents: e460f4f
Author: Stian Soiland-Reyes <st...@apache.org>
Authored: Wed Sep 27 22:49:09 2017 +0100
Committer: Stian Soiland-Reyes <st...@apache.org>
Committed: Wed Sep 27 22:51:38 2017 +0100
----------------------------------------------------------------------
.../org/apache/commons/io/FileSystemUtils.java | 22 +++++++++++---------
1 file changed, 12 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-io/blob/3af25efa/src/main/java/org/apache/commons/io/FileSystemUtils.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/io/FileSystemUtils.java b/src/main/java/org/apache/commons/io/FileSystemUtils.java
index 861cc66..06e90c2 100644
--- a/src/main/java/org/apache/commons/io/FileSystemUtils.java
+++ b/src/main/java/org/apache/commons/io/FileSystemUtils.java
@@ -145,8 +145,8 @@ public class FileSystemUtils {
//-----------------------------------------------------------------------
/**
- * Returns the free space on a drive or volume in kilobytes by invoking
- * the command line.
+ * Returns the free space on a drive or volume in kibibytes (1024 bytes)
+ * by invoking the command line.
* <pre>
* FileSystemUtils.freeSpaceKb("C:"); // Windows
* FileSystemUtils.freeSpaceKb("/volume"); // *nix
@@ -167,15 +167,15 @@ public class FileSystemUtils {
* @throws IllegalStateException if an error occurred in initialisation
* @throws IOException if an error occurs when finding the free space
* @since 1.2, enhanced OS support in 1.3
- * @deprecated As of 2.6 removed without replacement. Please use {@link java.nio.file.FileStore#getUsableSpace()}.
+ * @deprecated As of 2.6 deprecated without replacement. Please use {@link java.nio.file.FileStore#getUsableSpace()}.
*/
@Deprecated
public static long freeSpaceKb(final String path) throws IOException {
return freeSpaceKb(path, -1);
}
/**
- * Returns the free space on a drive or volume in kilobytes by invoking
- * the command line.
+ * Returns the free space on a drive or volume in kibibytes (1024 bytes)
+ * by invoking the command line.
* <pre>
* FileSystemUtils.freeSpaceKb("C:"); // Windows
* FileSystemUtils.freeSpaceKb("/volume"); // *nix
@@ -198,7 +198,7 @@ public class FileSystemUtils {
* @throws IllegalStateException if an error occurred in initialisation
* @throws IOException if an error occurs when finding the free space
* @since 2.0
- * @deprecated As of 2.6 removed without replacement. Please use {@link java.nio.file.FileStore#getUsableSpace()}.
+ * @deprecated As of 2.6 deprecated without replacement. Please use {@link java.nio.file.FileStore#getUsableSpace()}.
*/
@Deprecated
public static long freeSpaceKb(final String path, final long timeout) throws IOException {
@@ -206,7 +206,8 @@ public class FileSystemUtils {
}
/**
- * Returns the disk size of the volume which holds the working directory.
+ * Returns the free space for the working directory
+ * in kibibytes (1024 bytes) by invoking the command line.
* <p>
* Identical to:
* <pre>
@@ -216,7 +217,7 @@ public class FileSystemUtils {
* @throws IllegalStateException if an error occurred in initialisation
* @throws IOException if an error occurs when finding the free space
* @since 2.0
- * @deprecated As of 2.6 removed without replacement. Please use {@link java.nio.file.FileStore#getUsableSpace()}.
+ * @deprecated As of 2.6 deprecated without replacement. Please use {@link java.nio.file.FileStore#getUsableSpace()}.
*/
@Deprecated
public static long freeSpaceKb() throws IOException {
@@ -224,7 +225,8 @@ public class FileSystemUtils {
}
/**
- * Returns the disk size of the volume which holds the working directory.
+ * Returns the free space for the working directory
+ * in kibibytes (1024 bytes) by invoking the command line.
* <p>
* Identical to:
* <pre>
@@ -236,7 +238,7 @@ public class FileSystemUtils {
* @throws IllegalStateException if an error occurred in initialisation
* @throws IOException if an error occurs when finding the free space
* @since 2.0
- * @deprecated As of 2.6 removed without replacement. Please use {@link java.nio.file.FileStore#getUsableSpace()}.
+ * @deprecated As of 2.6 deprecated without replacement. Please use {@link java.nio.file.FileStore#getUsableSpace()}.
*/
@Deprecated
public static long freeSpaceKb(final long timeout) throws IOException {