org.apache.commons.io
Class FileSystemUtils

java.lang.Object
  org.apache.commons.io.FileSystemUtils

public class FileSystemUtils
extends Object

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:

• Get the free space on a drive

Since:

Commons IO 1.1

Version:

$Id: FileSystemUtils.java 293039 2005-10-01 23:00:40Z scolebourne $

Constructor Summary

FileSystemUtils()
Instances should NOT be constructed in standard programming.

Method Summary

static long

freeSpace(String path) Returns the free space on a drive or volume in a cross-platform manner.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileSystemUtils

public FileSystemUtils()

Instances should NOT be constructed in standard programming.

Method Detail

freeSpace

public static long freeSpace(String path)
                      throws IOException

Returns the free space on a drive or volume in a cross-platform manner. Note that some OS's are NOT currently supported, including OS/390.

 FileSystemUtils.freeSpace("C:");  // Windows
 FileSystemUtils.freeSpace("/volume");  // *nix
 

The free space is calculated via the command line. It uses 'dir /-c' on Windows and 'df' on *nix.

Parameters:

path - the path to get free space for, not null, not empty on Unix

Returns:

the amount of free drive space on the drive or volume

Throws:

IllegalArgumentException - if the path is invalid

IllegalStateException - if an error occurred in initialisation

IOException - if an error occurs when finding the free space