org.fest.util
Class Files

java.lang.Object
  extended by org.fest.util.Files

public class Files
extends Object

Understands utility methods related to files.

Author:
Yvonne Wang, Alex Ruiz

Method Summary
static File currentFolder()
          Returns the current directory.
static void delete(File file)
          Deletes the given file or directory.
static List<String> fileNamesIn(String dirName, boolean recurse)
          Returns the names of the files inside the specified directory.
static void flushAndClose(OutputStream out)
          Flushes and closes the given OutputStream.
static void flushAndClose(Writer writer)
          Flushes and closes the given Writer.
static File newFile(String path)
          Creates a new file using the given path.
static File newFolder(String path)
          Creates a new folder using the given path.
static File newTemporaryFile()
          Creates a new file in the system's temporary folder.
static File newTemporaryFolder()
          Creates a new folder in the system's temporary folder.
static File temporaryFolder()
          Returns the system's temporary folder.
static String temporaryFolderPath()
          Returns the path of the system's temporary folder.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

fileNamesIn

public static List<String> fileNamesIn(String dirName,
                                       boolean recurse)
Returns the names of the files inside the specified directory.

Parameters:
dirName - the name of the directory to start the search from.
recurse - if true, we will look in subdirectories.
Returns:
the names of the files inside the specified directory.
Throws:
IllegalArgumentException - if the given directory name does not point to an existing directory.

temporaryFolder

public static File temporaryFolder()
Returns the system's temporary folder.

Returns:
the system's temporary folder.
Throws:
FilesException - if this method cannot find or create the system's temporary folder.

temporaryFolderPath

public static String temporaryFolderPath()
Returns the path of the system's temporary folder. This method appends the system's file separator at the end of the path.

Returns:
the path of the system's temporary folder.

newTemporaryFile

public static File newTemporaryFile()
Creates a new file in the system's temporary folder. The name of the file will be the result of:
 concat(String.valueOf(System.currentTimeMillis()), ".txt");
 

Returns:
the created file.

newTemporaryFolder

public static File newTemporaryFolder()
Creates a new folder in the system's temporary folder. The name of the folder will be the result of:
 System.currentTimeMillis();
 

Returns:
the created file.

newFile

public static File newFile(String path)
Creates a new file using the given path.

Parameters:
path - the path of the new file.
Returns:
the new created file.
Throws:
FilesException - if the path belongs to an existing non-empty directory.
FilesException - if the path belongs to an existing file.
FilesException - if any I/O error is thrown when creating the new file.

newFolder

public static File newFolder(String path)
Creates a new folder using the given path.

Parameters:
path - the path of the new folder.
Returns:
the new created folder.
Throws:
FilesException - if the path belongs to an existing non-empty directory.
FilesException - if the path belongs to an existing file.
FilesException - if any I/O error is thrown when creating the new folder.

flushAndClose

public static void flushAndClose(Writer writer)
Flushes and closes the given Writer. Any I/O errors catched by this method are ignored and not rethrown.

Parameters:
writer - the writer to flush and close.

flushAndClose

public static void flushAndClose(OutputStream out)
Flushes and closes the given OutputStream. Any I/O errors catched by this method are ignored and not rethrown.

Parameters:
out - the output stream to flush and close.

currentFolder

public static File currentFolder()
Returns the current directory.

Returns:
the current directory.
Throws:
FilesException - if the current directory cannot be obtained.

delete

public static void delete(File file)
Deletes the given file or directory.

Parameters:
file - the file or directory to delete.


Copyright © 2007-2011 FEST (Fixtures for Easy Software Testing). All Rights Reserved.