Package org.fest.util

Class Files

  • public class Files
extends java.lang.Object
    Utility methods related to files.
    Author:
    Yvonne Wang, Alex Ruiz

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String contentOf​(java.io.File file, java.lang.String charsetName)
      Loads the text content of a file into a character string.
      static java.lang.String contentOf​(java.io.File file, java.nio.charset.Charset charset)
      Loads the text content of a file into a character string.
      static java.io.File currentFolder()
      Returns the current directory.
      static void delete​(java.io.File file)
      Deletes the given file or directory.
      static java.util.List<java.lang.String> fileNamesIn​(java.lang.String dirName, boolean recurse)
      Returns the names of the files inside the specified directory.
      static void flushAndClose​(java.io.OutputStream out)
      Flushes and closes the given OutputStream.
      static void flushAndClose​(java.io.Writer writer)
      Flushes and closes the given Writer.
      static java.io.File newFile​(java.lang.String path)
      Creates a new file using the given path.
      static java.io.File newFolder​(java.lang.String path)
      Creates a new directory using the given path.
      static java.io.File newTemporaryFile()
      Creates a new file in the system's temporary directory.
      static java.io.File newTemporaryFolder()
      Creates a new directory in the system's temporary directory.
      static java.io.File temporaryFolder()
      Returns the system's temporary directory.
      static java.lang.String temporaryFolderPath()
      Returns the path of the system's temporary directory.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • fileNamesIn

        public static java.util.List<java.lang.String> fileNamesIn​(java.lang.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:
        java.lang.IllegalArgumentException - if the given directory name does not point to an existing directory.

      • temporaryFolder

        public static java.io.File temporaryFolder()
        Returns the system's temporary directory.
        Returns:
        the system's temporary directory.
        Throws:
        FilesException - if this method cannot find or create the system's temporary directory.

      • temporaryFolderPath

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

      • newTemporaryFile

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

      • newTemporaryFolder

        public static java.io.File newTemporaryFolder()
        Creates a new directory in the system's temporary directory. The name of the directory will be the result of: 
         System.currentTimeMillis();
        Returns:
        the created file.

      • newFile

        public static java.io.File newFile​(java.lang.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 java.io.File newFolder​(java.lang.String path)
        Creates a new directory using the given path.
        Parameters:
        path - the path of the new directory.
        Returns:
        the new created directory.
        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 directory.

      • flushAndClose

        public static void flushAndClose​(java.io.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​(java.io.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 java.io.File currentFolder()
        Returns the current directory.
        Returns:
        the current directory.
        Throws:
        FilesException - if the current directory cannot be obtained.

      • delete

        public static void delete​(java.io.File file)
        Deletes the given file or directory.
        Parameters:
        file - the file or directory to delete.

      • contentOf

        public static java.lang.String contentOf​(java.io.File file,
                                         java.lang.String charsetName)
        Loads the text content of a file into a character string.
        Parameters:
        file - the file.
        charsetName - the name of the character set to use.
        Returns:
        the content of the file.
        Throws:
        java.lang.IllegalArgumentException - if the given character set is not supported on this platform.
        FilesException - if an I/O exception occurs.

      • contentOf

        public static java.lang.String contentOf​(java.io.File file,
                                         java.nio.charset.Charset charset)
        Loads the text content of a file into a character string.
        Parameters:
        file - the file.
        charset - the character set to use.
        Returns:
        the content of the file.
        Throws:
        java.lang.NullPointerException - if the given charset is null.
        FilesException - if an I/O exception occurs.