Package org.apache.maven.shared.utils.io

Class FileUtils

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FileUtils.FilterWrapper
      Deprecated.
      use org.apache.maven.shared.filtering.FilterWrapper

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected FileUtils()
      Protected constructor.

    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static void cleanDirectory​(java.io.File directory)
      Deprecated.
      use org.apache.commons.io.FileUtils.cleanDirectory()
      static boolean contentEquals​(java.io.File file1, java.io.File file2)
      Deprecated.
      use org.apache.commons.io.FileUtils.contentEquals()
      static void copyDirectory​(java.io.File sourceDirectory, java.io.File destinationDirectory)
      Deprecated.
      use org.apache.commons.io.FileUtils.copyDirectory()
      static void copyDirectory​(java.io.File sourceDirectory, java.io.File destinationDirectory, java.lang.String includes, java.lang.String excludes)
      Deprecated.
      use org.apache.commons.io.FileUtils.copyDirectory()
      static void copyDirectoryStructure​(java.io.File sourceDirectory, java.io.File destinationDirectory)
      Deprecated.
      use org.apache.commons.io.FileUtils.copyDirectory()
      static void copyFile​(java.io.File source, java.io.File destination)
      Deprecated.
      use java.nio.file.Files.copy(source.toPath(), destination.toPath(), LinkOption.NOFOLLOW_LINKS, StandardCopyOption.REPLACE_EXISTING)
      static void copyFile​(java.io.File from, java.io.File to, java.lang.String encoding, FileUtils.FilterWrapper... wrappers)
      Deprecated.
      use org.apache.maven.shared.filtering.FilteringUtils.copyFile() instead
      static void copyFile​(java.io.File from, java.io.File to, java.lang.String encoding, FileUtils.FilterWrapper[] wrappers, boolean overwrite)
      Deprecated.
      use org.apache.maven.shared.filtering.FilteringUtils.copyFile() instead
      static void copyFileToDirectory​(java.io.File source, java.io.File destinationDirectory)
      Deprecated.
      use org.apache.commons.io.FileUtils.copyFileToDirectory()
      static void copyURLToFile​(java.net.URL source, java.io.File destination)
      Deprecated.
      use java.nio.file.Files.copy(source.openStream(), destination.toPath(), StandardCopyOption.REPLACE_EXISTING)
      static java.io.File createSymbolicLink​(java.io.File symlink, java.io.File target)
      Create a new symbolic link, possibly replacing an existing symbolic link.
      static java.io.File createTempFile​(java.lang.String prefix, java.lang.String suffix, java.io.File parentDir)
      Deprecated.
      use java.nio.file.Files.createTempFile()
      static void delete​(java.io.File file)
      Deprecated.
      use java.nio.file.Files.delete(file.toPath())
      static void deleteDirectory​(java.io.File directory)
      Deprecated.
      use org.apache.commons.io.FileUtils.deleteDirectory()
      static void deleteDirectory​(java.lang.String directory)
      Deprecated.
      use org.apache.commons.io.FileUtils.deleteDirectory()
      static boolean deleteLegacyStyle​(java.io.File file)
      Deprecated.
      use java.nio.file.Files.delete(file.toPath())
      static java.lang.String dirname​(java.lang.String path)
      Deprecated.
      use Paths.get(path).getParent().getName()
      static java.lang.String extension​(java.lang.String path)
      Deprecated.
      use org.apache.commons.io.FilenameUtils.getExtension
      static void fileAppend​(java.lang.String fileName, java.lang.String data)
      Deprecated.
      use java.nio.file.Files.write(filename, data.getBytes(), StandardOpenOption.APPEND, StandardOpenOption.CREATE)
      static void fileAppend​(java.lang.String fileName, java.lang.String encoding, java.lang.String data)
      Deprecated.
      use java.nio.file.Files.write(filename, data.getBytes(encoding), StandardOpenOption.APPEND, StandardOpenOption.CREATE)
      static void fileDelete​(java.lang.String fileName)
      Deprecated.
      use Files.delete(Paths.get(fileName))
      static boolean fileExists​(java.lang.String fileName)
      Deprecated.
      use java.io.File.exists()
      static java.lang.String filename​(java.lang.String path)
      Deprecated.
      use Paths.get(path).getName()
      static java.lang.String fileRead​(java.io.File file)
      Deprecated.
      use new String(java.nio.file.Files.readAllBytes(file.toPath()))
      static java.lang.String fileRead​(java.io.File file, java.lang.String encoding)
      Deprecated.
      use new String(java.nio.file.Files.readAllBytes(file.toPath()), encoding)
      static java.lang.String fileRead​(java.lang.String file)
      Deprecated.
      use new String(java.nio.file.Files.readAllBytes(file))
      static java.lang.String[] fileReadArray​(java.io.File file)
      Deprecated.
      use java.nio.file.Files.readAllLines()
      static void fileWrite​(java.io.File file, java.lang.String encoding, java.lang.String data)
      Deprecated.
      use java.nio.file.Files.write(file.toPath(), data.getBytes(encoding), StandardOpenOption.CREATE)
      static void fileWrite​(java.lang.String fileName, java.lang.String data)
      Deprecated.
      use java.nio.file.Files.write(filename, data.getBytes(), StandardOpenOption.CREATE)
      static void fileWrite​(java.lang.String fileName, java.lang.String encoding, java.lang.String data)
      Deprecated.
      use java.nio.file.Files.write(Paths.get(filename), data.getBytes(encoding), StandardOpenOption.CREATE)
      static void fileWriteArray​(java.io.File file, java.lang.String... data)
      Deprecated.
      use java.nio.file.Files.write(file.toPath(), data.getBytes(encoding), StandardOpenOption.CREATE)
      static void fileWriteArray​(java.io.File file, java.lang.String encoding, java.lang.String... data)
      Deprecated.
      use java.nio.file.Files.write(file.toPath(), data.getBytes(encoding), StandardOpenOption.CREATE)
      static void forceDelete​(java.io.File file)
      Deprecated.
      use org.apache.commons.io.FileUtils.deleteQuietly()
      static void forceDelete​(java.lang.String file)
      Deprecated.
      use org.apache.commons.io.FileUtils.deleteQuietly()
      static void forceMkdir​(java.io.File file)
      Deprecated.
      use org.apache.commons.io.FileUtils.forceMkdir()
      static java.lang.String[] getDefaultExcludes()  
      static java.util.List<java.lang.String> getDefaultExcludesAsList()  
      static java.lang.String getDefaultExcludesAsString()  
      static java.util.List<java.lang.String> getDirectoryNames​(java.io.File directory, java.lang.String includes, java.lang.String excludes, boolean includeBasedir)
      Return the paths to the subdirectories in a directory, relative to the base directory.
      static java.util.List<java.lang.String> getDirectoryNames​(java.io.File directory, java.lang.String includes, java.lang.String excludes, boolean includeBasedir, boolean isCaseSensitive)
      Return the paths to the subdirectories in a directory, relative to the base directory.
      static java.lang.String getExtension​(java.lang.String filename)
      Deprecated.
      use org.apache.commons.io.FilenameUtils.getExtension()
      static java.util.List<java.lang.String> getFileAndDirectoryNames​(java.io.File directory, java.lang.String includes, java.lang.String excludes, boolean includeBasedir, boolean isCaseSensitive, boolean getFiles, boolean getDirectories)
      Return the paths to the files in a directory, relative to the base directory.
      static java.util.List<java.lang.String> getFileNames​(java.io.File directory, java.lang.String includes, java.lang.String excludes, boolean includeBasedir)
      Return a list of the files inside a base directory as relative paths from the base.
      static java.util.List<java.io.File> getFiles​(java.io.File directory, java.lang.String includes, java.lang.String excludes)
      Return a list of the files inside a base directory as relative paths from the base, using inclusion and exclusion Ant patterns, including the directory name in each of the files.
      static java.util.List<java.io.File> getFiles​(java.io.File directory, java.lang.String includes, java.lang.String excludes, boolean includeBasedir)
      Return a list of the files inside a base directory as relative paths from the base, using inclusion and exclusion Ant patterns.
      static java.lang.String[] getFilesFromExtension​(java.lang.String directory, java.lang.String... extensions)
      Given a directory and an array of extensions return an array of compliant files.
      static boolean isSymbolicLink​(java.io.File file)
      Deprecated.
      use java.nio.file.Files.isSymbolicLink(file.toPath())
      static boolean isSymbolicLinkForSure​(java.io.File file)
      Deprecated.
      use java.nio.file.Files.isSymbolicLink(file.toPath())
      static java.util.List<java.lang.String> loadFile​(java.io.File file)
      Deprecated.
      assumes the platform default character set
      static void mkdir​(java.lang.String dir)
      Deprecated.
      use java.nio.file.Files.createDirectories(Paths.get(dir))
      static java.lang.String normalize​(java.lang.String path)
      Deprecated.
      use org.apache.commons.io.FilenameUtils.normalize()
      static java.lang.String removeExtension​(java.lang.String filename)
      Deprecated.
      use org.apache.commons.io.FilenameUtils.removeExtension()
      static void rename​(java.io.File from, java.io.File to)
      Deprecated.
      use java.nio.file.Files.move()
      static java.io.File resolveFile​(java.io.File baseFile, java.lang.String filename)
      Resolve a file filename to its canonical form.
      static long sizeOfDirectory​(java.io.File directory)
      Deprecated.
      use org.apache.commons.io.FileUtils.sizeOf()
      static long sizeOfDirectory​(java.lang.String directory)
      Deprecated.
      use org.apache.commons.io.FileUtils.sizeOf()
      static java.io.File toFile​(java.net.URL url)
      Convert from a URL to a File.
      static java.net.URL[] toURLs​(java.io.File... files)
      Convert the array of Files into a list of URLs.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • FileUtils

        protected FileUtils()
        Protected constructor.

    • Method Detail

      • getDefaultExcludesAsList

        public static java.util.List<java.lang.String> getDefaultExcludesAsList()
        Returns:
        the default excludes pattern as list
        See Also:
        getDefaultExcludes()

      • dirname

        @Deprecated
public static java.lang.String dirname​(java.lang.String path)
        Deprecated.
        use Paths.get(path).getParent().getName()
        Returns the directory path portion of a file specification string. Matches the equally named unix command.
        Parameters:
        path - the file path
        Returns:
        the directory portion excluding the ending file separator

      • filename

        @Deprecated
public static java.lang.String filename​(java.lang.String path)
        Deprecated.
        use Paths.get(path).getName()
        Returns the filename portion of a path.
        Parameters:
        path - the file path
        Returns:
        the filename string with extension

      • extension

        @Deprecated
public static java.lang.String extension​(java.lang.String path)
        Deprecated.
        use org.apache.commons.io.FilenameUtils.getExtension
        Returns the extension portion of a file path. This is everything after the last dot '.' in the path (NOT including the dot).
        Parameters:
        path - the file path
        Returns:
        the extension of the file

      • fileExists

        @Deprecated
public static boolean fileExists​(java.lang.String fileName)
        Deprecated.
        use java.io.File.exists()
        Check if a file exists.
        Parameters:
        fileName - the file path
        Returns:
        true if file exists

      • fileRead

        @Deprecated
public static java.lang.String fileRead​(java.lang.String file)
                                 throws java.io.IOException
        Deprecated.
        use new String(java.nio.file.Files.readAllBytes(file))
        Note: the file content is read with platform encoding.
        Parameters:
        file - the file path
        Returns:
        the file content using the platform encoding
        Throws:
        java.io.IOException - if any

      • fileRead

        @Deprecated
public static java.lang.String fileRead​(java.io.File file)
                                 throws java.io.IOException
        Deprecated.
        use new String(java.nio.file.Files.readAllBytes(file.toPath()))
        Note: the file content is read with platform encoding.
        Parameters:
        file - the file path
        Returns:
        the file content using the platform encoding
        Throws:
        java.io.IOException - if any

      • fileRead

        @Deprecated
public static java.lang.String fileRead​(java.io.File file,
                                        java.lang.String encoding)
                                 throws java.io.IOException
        Deprecated.
        use new String(java.nio.file.Files.readAllBytes(file.toPath()), encoding)
        Parameters:
        file - the file path
        encoding - the wanted encoding
        Returns:
        the file content using the specified encoding
        Throws:
        java.io.IOException - if any

      • fileReadArray

        @Deprecated
public static java.lang.String[] fileReadArray​(java.io.File file)
                                        throws java.io.IOException
        Deprecated.
        use java.nio.file.Files.readAllLines()
        Parameters:
        file - the file path
        Returns:
        the file content lines as String[] using the system default encoding. An empty List if the file doesn't exist.
        Throws:
        java.io.IOException - in case of failure

      • fileAppend

        @Deprecated
public static void fileAppend​(java.lang.String fileName,
                              java.lang.String data)
                       throws java.io.IOException
        Deprecated.
        use java.nio.file.Files.write(filename, data.getBytes(), StandardOpenOption.APPEND, StandardOpenOption.CREATE)
        Appends data to a file. The file is created if it does not exist. Note: the data is written with platform encoding.
        Parameters:
        fileName - the path of the file to write
        data - the content to write to the file
        Throws:
        java.io.IOException - if any

      • fileAppend

        @Deprecated
public static void fileAppend​(java.lang.String fileName,
                              java.lang.String encoding,
                              java.lang.String data)
                       throws java.io.IOException
        Deprecated.
        use java.nio.file.Files.write(filename, data.getBytes(encoding), StandardOpenOption.APPEND, StandardOpenOption.CREATE)
        Appends data to a file. The file will be created if it does not exist.
        Parameters:
        fileName - the path of the file to write
        encoding - the encoding of the file
        data - the content to write to the file
        Throws:
        java.io.IOException - if any

      • fileWrite

        @Deprecated
public static void fileWrite​(java.lang.String fileName,
                             java.lang.String data)
                      throws java.io.IOException
        Deprecated.
        use java.nio.file.Files.write(filename, data.getBytes(), StandardOpenOption.CREATE)
        Writes data to a file. The file will be created if it does not exist. Note: the data is written with platform encoding.
        Parameters:
        fileName - the path of the file to write
        data - the content to write to the file
        Throws:
        java.io.IOException - if any

      • fileWrite

        @Deprecated
public static void fileWrite​(java.lang.String fileName,
                             java.lang.String encoding,
                             java.lang.String data)
                      throws java.io.IOException
        Deprecated.
        use java.nio.file.Files.write(Paths.get(filename), data.getBytes(encoding), StandardOpenOption.CREATE)
        Writes data to a file. The file will be created if it does not exist.
        Parameters:
        fileName - the path of the file to write
        encoding - the encoding of the file
        data - the content to write to the file
        Throws:
        java.io.IOException - if any

      • fileWrite

        @Deprecated
public static void fileWrite​(java.io.File file,
                             java.lang.String encoding,
                             java.lang.String data)
                      throws java.io.IOException
        Deprecated.
        use java.nio.file.Files.write(file.toPath(), data.getBytes(encoding), StandardOpenOption.CREATE)
        Writes data to a file. The file will be created if it does not exist.
        Parameters:
        file - the path of the file to write
        encoding - the encoding of the file
        data - the content to write to the file
        Throws:
        java.io.IOException - if any

      • fileWriteArray

        @Deprecated
public static void fileWriteArray​(java.io.File file,
                                  java.lang.String... data)
                           throws java.io.IOException
        Deprecated.
        use java.nio.file.Files.write(file.toPath(), data.getBytes(encoding), StandardOpenOption.CREATE)
        Writes String array data to a file in the systems default encoding. The file will be created if it does not exist.
        Parameters:
        file - the path of the file to write
        data - the content to write to the file
        Throws:
        java.io.IOException - if any

      • fileWriteArray

        @Deprecated
public static void fileWriteArray​(java.io.File file,
                                  java.lang.String encoding,
                                  java.lang.String... data)
                           throws java.io.IOException
        Deprecated.
        use java.nio.file.Files.write(file.toPath(), data.getBytes(encoding), StandardOpenOption.CREATE)
        Writes String array data to a file. The file is created if it does not exist.
        Parameters:
        file - the path of the file to write
        encoding - the encoding of the file
        data - the content to write to the file
        Throws:
        java.io.IOException - if any

      • fileDelete

        @Deprecated
public static void fileDelete​(java.lang.String fileName)
        Deprecated.
        use Files.delete(Paths.get(fileName))
        Deletes a file.
        Parameters:
        fileName - the path of the file to delete

      • getFilesFromExtension

        public static java.lang.String[] getFilesFromExtension​(java.lang.String directory,
                                                       java.lang.String... extensions)
        Given a directory and an array of extensions return an array of compliant files.

        The given extensions should be like "java" and not like ".java".

        Parameters:
        directory - the path of the directory
        extensions - an array of expected extensions
        Returns:
        an array of files for the wanted extensions

      • mkdir

        @Deprecated
public static void mkdir​(java.lang.String dir)
        Deprecated.
        use java.nio.file.Files.createDirectories(Paths.get(dir))
        Simple way to make a directory.
        Parameters:
        dir - the directory to create
        Throws:
        java.lang.IllegalArgumentException - if the dir contains illegal Windows characters under Windows OS
        See Also:
        INVALID_CHARACTERS_FOR_WINDOWS_FILE_NAME

      • contentEquals

        @Deprecated
public static boolean contentEquals​(java.io.File file1,
                                    java.io.File file2)
                             throws java.io.IOException
        Deprecated.
        use org.apache.commons.io.FileUtils.contentEquals()
        Compare the contents of two files to determine if they are equal or not.
        Parameters:
        file1 - the first file
        file2 - the second file
        Returns:
        true if the content of the files are equal or they both don't exist, false otherwise
        Throws:
        java.io.IOException - if any

      • toFile

        public static java.io.File toFile​(java.net.URL url)
        Convert from a URL to a File.
        Parameters:
        url - file URL
        Returns:
        the equivalent File object, or null if the URL's protocol is not file

      • toURLs

        public static java.net.URL[] toURLs​(java.io.File... files)
                             throws java.io.IOException
        Convert the array of Files into a list of URLs.
        Parameters:
        files - the array of files
        Returns:
        the array of URLs
        Throws:
        java.io.IOException - if an error occurs

      • removeExtension

        @Deprecated
public static java.lang.String removeExtension​(java.lang.String filename)
        Deprecated.
        use org.apache.commons.io.FilenameUtils.removeExtension()
        Remove extension from a path. E.g. 
         foo.txt    → foo
 a\b\c.jpg  → a\b\c
 a\b\c      → a\b\c
        Parameters:
        filename - the path of the file
        Returns:
        the filename minus extension

      • getExtension

        @Deprecated
public static java.lang.String getExtension​(java.lang.String filename)
        Deprecated.
        use org.apache.commons.io.FilenameUtils.getExtension()
        Get extension from a path. E.g. 
         foo.txt    → "txt"
 a\b\c.jpg  → "jpg"
 a\b\c      → ""
        Parameters:
        filename - the path of the file
        Returns:
        the extension of filename or "" if none

      • copyFileToDirectory

        @Deprecated
public static void copyFileToDirectory​(java.io.File source,
                                       java.io.File destinationDirectory)
                                throws java.io.IOException
        Deprecated.
        use org.apache.commons.io.FileUtils.copyFileToDirectory()
        Copy file from source to destination. If destinationDirectory does not exist, it (and any parent directories) will be created. If a file source in destinationDirectory exists, it will be overwritten.
        Parameters:
        source - an existing File to copy
        destinationDirectory - a directory to copy source into
        Throws:
        java.lang.IllegalArgumentException - if destinationDirectory isn't a directory
        java.io.IOException - if source does not exist, the file in destinationDirectory cannot be written to, or an IO error occurs during copying
        java.io.FileNotFoundException - if source isn't a normal file

      • copyFile

        @Deprecated
public static void copyFile​(java.io.File source,
                            java.io.File destination)
                     throws java.io.IOException
        Deprecated.
        use java.nio.file.Files.copy(source.toPath(), destination.toPath(), LinkOption.NOFOLLOW_LINKS, StandardCopyOption.REPLACE_EXISTING)
        Copy file from source to destination. The directories up to destination will be created if they don't already exist. destination will be overwritten if it already exists.
        Parameters:
        source - an existing non-directory File to copy bytes from
        destination - a non-directory File to write bytes to (possibly overwriting)
        Throws:
        java.io.IOException - if source does not exist, destination cannot be written to, or an IO error occurs during copying
        java.io.FileNotFoundException - if destination is a directory

      • copyURLToFile

        public static void copyURLToFile​(java.net.URL source,
                                 java.io.File destination)
                          throws java.io.IOException
        Deprecated.
        use java.nio.file.Files.copy(source.openStream(), destination.toPath(), StandardCopyOption.REPLACE_EXISTING)
        Copies bytes from the URL source to a file destination. The directories up to destination will be created if they don't already exist. destination will be overwritten if it already exists.
        Parameters:
        source - a URL to copy bytes from
        destination - a non-directory File to write bytes to (possibly overwriting)
        Throws:
        java.io.IOException - if
        • source URL cannot be opened
        • destination cannot be written to
        • an IO error occurs during copying

      • normalize

        @Deprecated
public static java.lang.String normalize​(java.lang.String path)
        Deprecated.
        use org.apache.commons.io.FilenameUtils.normalize()
        Normalize a path. Eliminates "/../" and "/./" in a string. Returns null if the ..'s went past the root. Eg: 
         /foo//               →     /foo/
 /foo/./              →     /foo/
 /foo/../bar          →     /bar
 /foo/../bar/         →     /bar/
 /foo/../bar/../baz   →     /baz
 //foo//./bar         →     /foo/bar
 /../                 →     null
        Parameters:
        path - the path to normalize
        Returns:
        the normalized String, or null if too many ..'s

      • resolveFile

        public static java.io.File resolveFile​(java.io.File baseFile,
                                       java.lang.String filename)
        Resolve a file filename to its canonical form. If filename is relative (doesn't start with /), it is resolved relative to baseFile. Otherwise it is treated as a normal root-relative path.
        Parameters:
        baseFile - where to resolve filename from, if filename is relative
        filename - absolute or relative file path to resolve
        Returns:
        the canonical File of filename

      • forceDelete

        @Deprecated
public static void forceDelete​(java.lang.String file)
                        throws java.io.IOException
        Deprecated.
        use org.apache.commons.io.FileUtils.deleteQuietly()
        Delete a file. If file is directory, delete it and all sub-directories.
        Parameters:
        file - the file path
        Throws:
        java.io.IOException - if any

      • forceDelete

        @Deprecated
public static void forceDelete​(java.io.File file)
                        throws java.io.IOException
        Deprecated.
        use org.apache.commons.io.FileUtils.deleteQuietly()
        Delete a file. If file is directory, delete it and all sub-directories.
        Parameters:
        file - a file
        Throws:
        java.io.IOException - if any

      • delete

        @Deprecated
public static void delete​(java.io.File file)
                   throws java.io.IOException
        Deprecated.
        use java.nio.file.Files.delete(file.toPath())
        Deletes a file.
        Parameters:
        file - the file to delete
        Throws:
        java.io.IOException - if the file cannot be deleted

      • deleteLegacyStyle

        @Deprecated
public static boolean deleteLegacyStyle​(java.io.File file)
        Deprecated.
        use java.nio.file.Files.delete(file.toPath())
        Parameters:
        file - the file
        Returns:
        true / false

      • forceMkdir

        @Deprecated
public static void forceMkdir​(java.io.File file)
                       throws java.io.IOException
        Deprecated.
        use org.apache.commons.io.FileUtils.forceMkdir()
        Make a directory.
        Parameters:
        file - not null
        Throws:
        java.lang.IllegalArgumentException - if the file contains illegal Windows characters under Windows OS
        java.io.IOException - if a file already exists with the specified name or the directory is unable to be created
        See Also:
        INVALID_CHARACTERS_FOR_WINDOWS_FILE_NAME

      • deleteDirectory

        @Deprecated
public static void deleteDirectory​(java.lang.String directory)
                            throws java.io.IOException
        Deprecated.
        use org.apache.commons.io.FileUtils.deleteDirectory()
        Recursively delete a directory.
        Parameters:
        directory - a directory
        Throws:
        java.io.IOException - if any

      • deleteDirectory

        @Deprecated
public static void deleteDirectory​(java.io.File directory)
                            throws java.io.IOException
        Deprecated.
        use org.apache.commons.io.FileUtils.deleteDirectory()
        Recursively delete a directory.
        Parameters:
        directory - a directory
        Throws:
        java.io.IOException - if any

      • cleanDirectory

        @Deprecated
public static void cleanDirectory​(java.io.File directory)
                           throws java.io.IOException
        Deprecated.
        use org.apache.commons.io.FileUtils.cleanDirectory()
        Remove all files from a directory without deleting it.
        Parameters:
        directory - a directory
        Throws:
        java.io.IOException - if any. This can leave cleaning in a half-finished state where some but not all files have been deleted.

      • sizeOfDirectory

        @Deprecated
public static long sizeOfDirectory​(java.lang.String directory)
        Deprecated.
        use org.apache.commons.io.FileUtils.sizeOf()
        Recursively count size of a directory.
        Parameters:
        directory - a directory
        Returns:
        size of directory in bytes

      • sizeOfDirectory

        @Deprecated
public static long sizeOfDirectory​(java.io.File directory)
        Deprecated.
        use org.apache.commons.io.FileUtils.sizeOf()
        Recursively count size of a directory.
        Parameters:
        directory - a directory
        Returns:
        size of directory in bytes

      • getFiles

        public static java.util.List<java.io.File> getFiles​(java.io.File directory,
                                                    java.lang.String includes,
                                                    java.lang.String excludes)
                                             throws java.io.IOException
        Return a list of the files inside a base directory as relative paths from the base, using inclusion and exclusion Ant patterns, including the directory name in each of the files. This is recursive and descends into subdirectories. However it does not include the subdirectories themselves in the returned list. This method uses case sensitive file names.
        Parameters:
        directory - the directory to scan
        includes - the Ant includes pattern, comma separated
        excludes - the Ant excludes pattern, comma separated
        Returns:
        a list of File objects
        Throws:
        java.io.IOException - never
        See Also:
        getFileNames(File, String, String, boolean)

      • getFiles

        public static java.util.List<java.io.File> getFiles​(java.io.File directory,
                                                    java.lang.String includes,
                                                    java.lang.String excludes,
                                                    boolean includeBasedir)
                                             throws java.io.IOException
        Return a list of the files inside a base directory as relative paths from the base, using inclusion and exclusion Ant patterns. This is recursive and descends into subdirectories. However it does not include the subdirectories themselves in the returned list. This method uses case sensitive file names.
        Parameters:
        directory - the directory to scan
        includes - the includes pattern, comma separated
        excludes - the excludes pattern, comma separated
        includeBasedir - true to include the base dir in each file
        Returns:
        a list of File objects
        Throws:
        java.io.IOException - never
        See Also:
        getFileNames(File, String, String, boolean)

      • getFileNames

        public static java.util.List<java.lang.String> getFileNames​(java.io.File directory,
                                                            java.lang.String includes,
                                                            java.lang.String excludes,
                                                            boolean includeBasedir)
                                                     throws java.io.IOException
        Return a list of the files inside a base directory as relative paths from the base. This is recursive and descends into subdirectories. However it does not include the subdirectories themselves in the returned list. This method uses case sensitive file names.
        Parameters:
        directory - the directory to scan
        includes - the Ant includes pattern, comma separated
        excludes - the Ant excludes pattern, comma separated
        includeBasedir - true to include the base directory in each String of file
        Returns:
        a list of file names
        Throws:
        java.io.IOException - never

      • getDirectoryNames

        public static java.util.List<java.lang.String> getDirectoryNames​(java.io.File directory,
                                                                 java.lang.String includes,
                                                                 java.lang.String excludes,
                                                                 boolean includeBasedir)
                                                          throws java.io.IOException
        Return the paths to the subdirectories in a directory, relative to the base directory. This is recursive and descends into subdirectories. This method use case sensitive file name.
        Parameters:
        directory - the base directory to search
        includes - the Ant includes pattern, comma separated
        excludes - the Ant excludes pattern, comma separated
        includeBasedir - true to include the base directory at the start of each path
        Returns:
        a list of relative paths of directories
        Throws:
        java.io.IOException - never

      • getDirectoryNames

        public static java.util.List<java.lang.String> getDirectoryNames​(java.io.File directory,
                                                                 java.lang.String includes,
                                                                 java.lang.String excludes,
                                                                 boolean includeBasedir,
                                                                 boolean isCaseSensitive)
                                                          throws java.io.IOException
        Return the paths to the subdirectories in a directory, relative to the base directory. This is recursive and descends into subdirectories.
        Parameters:
        directory - the base directory to search
        includes - the Ant includes pattern, comma separated
        excludes - the Ant excludes pattern, comma separated
        includeBasedir - true to include the base directory at the start of each path
        isCaseSensitive - true if the includes and excludes are case sensitive
        Returns:
        a list of relative paths of directories
        Throws:
        java.io.IOException - never

      • getFileAndDirectoryNames

        public static java.util.List<java.lang.String> getFileAndDirectoryNames​(java.io.File directory,
                                                                        java.lang.String includes,
                                                                        java.lang.String excludes,
                                                                        boolean includeBasedir,
                                                                        boolean isCaseSensitive,
                                                                        boolean getFiles,
                                                                        boolean getDirectories)
        Return the paths to the files in a directory, relative to the base directory. This is recursive and descends into subdirectories.
        Parameters:
        directory - the directory to scan
        includes - the Ant includes pattern, comma separated
        excludes - the Ant excludes pattern, comma separated
        includeBasedir - true to include the base directory at the start of each path
        isCaseSensitive - true if the includes and excludes are case sensitive
        getFiles - true to include regular files in the list
        getDirectories - true to include directories in the list
        Returns:
        a list of relative paths

      • copyDirectory

        @Deprecated
public static void copyDirectory​(java.io.File sourceDirectory,
                                 java.io.File destinationDirectory)
                          throws java.io.IOException
        Deprecated.
        use org.apache.commons.io.FileUtils.copyDirectory()
        Copy the contents of a directory into another one.
        Parameters:
        sourceDirectory - the source directory. If the source does not exist, the method simply returns.
        destinationDirectory - the target directory; will be created if it doesn't exist
        Throws:
        java.io.IOException - if any

      • copyDirectory

        @Deprecated
public static void copyDirectory​(java.io.File sourceDirectory,
                                 java.io.File destinationDirectory,
                                 java.lang.String includes,
                                 java.lang.String excludes)
                          throws java.io.IOException
        Deprecated.
        use org.apache.commons.io.FileUtils.copyDirectory()
        Copy the contents of a directory into another one.
        Parameters:
        sourceDirectory - the source directory
        destinationDirectory - the target directory
        includes - ant include pattern
        excludes - ant exclude pattern
        Throws:
        java.io.IOException - if the source is a file or cannot be copied
        See Also:
        getFiles(File, String, String)

      • copyDirectoryStructure

        @Deprecated
public static void copyDirectoryStructure​(java.io.File sourceDirectory,
                                          java.io.File destinationDirectory)
                                   throws java.io.IOException
        Deprecated.
        use org.apache.commons.io.FileUtils.copyDirectory()
        Copies an entire directory structure.

        Note:

        • It will include empty directories.
        • The sourceDirectory must exist.
        Parameters:
        sourceDirectory - the existing directory to be copied
        destinationDirectory - the new directory to be created
        Throws:
        java.io.IOException - if any

      • rename

        @Deprecated
public static void rename​(java.io.File from,
                          java.io.File to)
                   throws java.io.IOException
        Deprecated.
        use java.nio.file.Files.move()
        Renames a file, even if that involves crossing file system boundaries.

        This will remove to (if it exists), ensure that to's parent directory exists and move from, which involves deleting from as well.

        Parameters:
        from - the file to move
        to - the new file name
        Throws:
        java.io.IOException - if anything bad happens during this process. Note that to may have been deleted already when this happens.

      • createTempFile

        @Deprecated
public static java.io.File createTempFile​(java.lang.String prefix,
                                          java.lang.String suffix,
                                          java.io.File parentDir)
        Deprecated.
        use java.nio.file.Files.createTempFile()

        Create a temporary file in a given directory.

        The file denoted by the returned abstract pathname did not exist before this method was invoked, any subsequent invocation of this method will yield a different file name.

        The filename is prefixNNNNNsuffix where NNNN is a random number

        This method is different to File.createTempFile(String, String, File) as it doesn't create the file itself. It uses the location pointed to by java.io.tmpdir when the parentDir attribute is null.

        To automatically delete the file created by this method, use the File.deleteOnExit() method.

        Parameters:
        prefix - prefix before the random number
        suffix - file extension; include the '.'
        parentDir - directory to create the temporary file in -java.io.tmpdir used if not specified
        Returns:
        a File reference to the new temporary file

      • copyFile

        @Deprecated
public static void copyFile​(java.io.File from,
                            java.io.File to,
                            java.lang.String encoding,
                            FileUtils.FilterWrapper... wrappers)
                     throws java.io.IOException
        Deprecated.
        use org.apache.maven.shared.filtering.FilteringUtils.copyFile() instead
        If wrappers is null or empty, the file will be copied only if to.lastModified() < from.lastModified()
        Parameters:
        from - the file to copy
        to - the destination file
        encoding - the file output encoding (only if wrappers is not empty)
        wrappers - array of FileUtils.FilterWrapper
        Throws:
        java.io.IOException - if an IO error occurs during copying or filtering

      • copyFile

        @Deprecated
public static void copyFile​(java.io.File from,
                            java.io.File to,
                            java.lang.String encoding,
                            FileUtils.FilterWrapper[] wrappers,
                            boolean overwrite)
                     throws java.io.IOException
        Deprecated.
        use org.apache.maven.shared.filtering.FilteringUtils.copyFile() instead
        If wrappers is null or empty, the file will be copied only if to.lastModified() < from.lastModified() or if overwrite is true
        Parameters:
        from - the file to copy
        to - the destination file
        encoding - the file output encoding (only if wrappers is not empty)
        wrappers - array of FileUtils.FilterWrapper
        overwrite - if true and wrappers is null or empty, the file will be copied even if to.lastModified() < from.lastModified()
        Throws:
        java.io.IOException - if an IO error occurs during copying or filtering

      • loadFile

        @Deprecated
public static java.util.List<java.lang.String> loadFile​(java.io.File file)
                                                 throws java.io.IOException
        Deprecated.
        assumes the platform default character set
        Note: the file content is read with platform encoding.
        Parameters:
        file - the file
        Returns:
        a List containing every every line not starting with # and not empty
        Throws:
        java.io.IOException - if any

      • isSymbolicLink

        @Deprecated
public static boolean isSymbolicLink​(java.io.File file)
                              throws java.io.IOException
        Deprecated.
        use java.nio.file.Files.isSymbolicLink(file.toPath())
        Checks whether a given file is a symbolic link.
        Parameters:
        file - the file to check
        Returns:
        true if symbolic link false otherwise
        Throws:
        java.io.IOException - in case of failure

      • isSymbolicLinkForSure

        @Deprecated
public static boolean isSymbolicLinkForSure​(java.io.File file)
                                     throws java.io.IOException
        Deprecated.
        use java.nio.file.Files.isSymbolicLink(file.toPath())
        Checks whether a given file is a symbolic link.
        Parameters:
        file - the file to check
        Returns:
        true if and only if we reliably can say this is a symlink
        Throws:
        java.io.IOException - in case of failure

      • createSymbolicLink

        public static java.io.File createSymbolicLink​(java.io.File symlink,
                                              java.io.File target)
                                       throws java.io.IOException
        Create a new symbolic link, possibly replacing an existing symbolic link.
        Parameters:
        symlink - the link name
        target - the target
        Returns:
        the linked file
        Throws:
        java.io.IOException - in case of an error
        See Also:
        which creates a new symbolic link but does not replace existing symbolic links