|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.io.FileSystemUtils
public class FileSystemUtils
General File System utilities.
This class provides static utility methods for general file system
functions not provided via the JDK File
class.
The current functions provided are:
Field Summary | |
---|---|
private static int |
INIT_PROBLEM
Operating system state flag for error. |
private static FileSystemUtils |
INSTANCE
Singleton instance, used mainly for testing. |
private static int |
OS
The operating system flag. |
private static int |
OTHER
Operating system state flag for neither Unix nor Windows. |
private static int |
UNIX
Operating system state flag for Unix. |
private static int |
WINDOWS
Operating system state flag for Windows. |
Constructor Summary | |
---|---|
FileSystemUtils()
Instances should NOT be constructed in standard programming. |
Method Summary | |
---|---|
static long |
freeSpace(java.lang.String path)
Returns the free space on a drive or volume by invoking the command line. |
static long |
freeSpaceKb(java.lang.String path)
Returns the free space on a drive or volume in kilobytes by invoking the command line. |
(package private) long |
freeSpaceOS(java.lang.String path,
int os,
boolean kb)
Returns the free space on a drive or volume in a cross-platform manner. |
(package private) long |
freeSpaceUnix(java.lang.String path,
boolean kb)
Find free space on the *nix platform using the 'df' command. |
(package private) long |
freeSpaceWindows(java.lang.String path)
Find free space on the Windows platform using the 'dir' command. |
(package private) java.io.BufferedReader |
openProcessStream(java.lang.String[] params)
Opens the stream to be operating system. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final FileSystemUtils INSTANCE
private static final int INIT_PROBLEM
private static final int OTHER
private static final int WINDOWS
private static final int UNIX
private static final int OS
Constructor Detail |
---|
public FileSystemUtils()
Method Detail |
---|
public static long freeSpace(java.lang.String path) throws java.io.IOException
See also freeSpaceKb(String)
for a better implementation
which normalizes to kilobytes.
Note that some OS's are NOT currently supported, including OS/390.
FileSystemUtils.freeSpace("C:"); // Windows FileSystemUtils.freeSpace("/volume"); // *nixThe free space is calculated via the command line. It uses 'dir /-c' on Windows and 'df' on *nix.
path
- the path to get free space for, not null, not empty on Unix
java.lang.IllegalArgumentException
- if the path is invalid
java.lang.IllegalStateException
- if an error occurred in initialisation
java.io.IOException
- if an error occurs when finding the free spacepublic static long freeSpaceKb(java.lang.String path) throws java.io.IOException
FileSystemUtils.freeSpaceKb("C:"); // Windows FileSystemUtils.freeSpaceKb("/volume"); // *nixThe free space is calculated via the command line. It uses 'dir /-c' on Windows and 'df -k' on *nix.
path
- the path to get free space for, not null, not empty on Unix
java.lang.IllegalArgumentException
- if the path is invalid
java.lang.IllegalStateException
- if an error occurred in initialisation
java.io.IOException
- if an error occurs when finding the free spacelong freeSpaceOS(java.lang.String path, int os, boolean kb) throws java.io.IOException
FileSystemUtils.freeSpace("C:"); // Windows FileSystemUtils.freeSpace("/volume"); // *nixThe free space is calculated via the command line. It uses 'dir /-c' on Windows and 'df' on *nix.
path
- the path to get free space for, not null, not empty on Unixos
- the operating system codekb
- whether to normalize to kilobytes
java.lang.IllegalArgumentException
- if the path is invalid
java.lang.IllegalStateException
- if an error occurred in initialisation
java.io.IOException
- if an error occurs when finding the free spacelong freeSpaceWindows(java.lang.String path) throws java.io.IOException
path
- the path to get free space for, including the colon
java.io.IOException
- if an error occurslong freeSpaceUnix(java.lang.String path, boolean kb) throws java.io.IOException
path
- the path to get free space forkb
- whether to normalize to kilobytes
java.io.IOException
- if an error occursjava.io.BufferedReader openProcessStream(java.lang.String[] params) throws java.io.IOException
params
- the command parameters
java.io.IOException
- if an error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |