com.atlassian.clover.util

Class FileUtils

java.lang.Object

com.atlassian.clover.util.FileUtils

public class FileUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	JAVA_IO_TMPDIR

Method Summary

Modifier and Type	Method and Description
static long	calcAdlerChecksum(File f, String encoding)
int	compareLastModified(long date, File file) Compares a given date with the last modified date of a file, taking into account the filesystem resolution for file dates available on the current platform.
static File	createEmptyDir(File parent, String name)
static File	createTempDir(String name)
static File	createTempDir(String name, File parent)
static boolean	deltree(File rootDir) delete a file, or directory and all of its contents
static void	dirCopy(File srcDir, File destDir, boolean deleteDestDir) Copies the whole content (files and subdirectories) from
static void	fileCopy(File src, File dest)
static String	fromURI(String uri) *** stolen from Apache Ant 1.6 Constructs a file path from a file: URI.
static File	getCurrentDirIfNull(File dir)
static FileUtils	getInstance()
static File	getJavaTempDir() Returns system's temporary directory as defined in java.io.tmpdir
static String	getNormalizedPath(String inputPath) Converts all backslashes to forward-slashes, so that Unix-style file separator is used.
long	getPlatformFSResolution()
static String	getPlatformSpecificPath(String inputPath) Converts all forward-slashes and back-slashes to a platform-specific file separator (i.e.
static String	getRelativePath(File a, File b)
static String	getRelativePath(File a, File b, String pathSep)
static String	getRelativePath(String a, String b)
static String	getRelativePath(String a, String b, String pathSep)
static void	inputStreamToFile(InputStream in, File outFile) Read data from input stream in and write to outFile file.
static boolean	isAncestorOf(File a, File b)
static File[]	listMatchingFilesForDir(File dir, String regex) Lists only the files, not the directories for a given directory.
static String	readChars(DataInputStream in)
static void	readerCopy(Reader src, Writer dest)
static void	resourceToFile(ClassLoader classLoader, String resourcePath, File outputFile) Copy resourcePath resource using classLoader to outputFile.
static void	streamCopy(InputStream inputStream, OutputStream outputStream)

Methods inherited from class java.lang.Object

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

Field Detail

JAVA_IO_TMPDIR

public static final String JAVA_IO_TMPDIR

See Also:

Constant Field Values

Method Detail

getInstance

public static FileUtils getInstance()

getJavaTempDir

public static File getJavaTempDir()

Returns system's temporary directory as defined in java.io.tmpdir

Returns:

File temporary directory

Throws:

RuntimeException - if java.io.tmpdir is not set

getPlatformFSResolution

public long getPlatformFSResolution()

readerCopy

public static void readerCopy(Reader src,
                              Writer dest)
                       throws IOException

Throws:

IOException

fileCopy

public static void fileCopy(File src,
                            File dest)
                     throws IOException

Throws:

IOException

dirCopy

public static void dirCopy(File srcDir,
                           File destDir,
                           boolean deleteDestDir)
                    throws IOException

Copies the whole content (files and subdirectories) from

srcDir

to

destDir

preserving directory layout. If

deleteDestDir

is set to true, destination directory will be deleted if exists. Otherwise files/subdirectories from source directory will be added to existing target directory (possibly overwriting existing files). Note that timestamps are not preserved.

Throws:

IOException

inputStreamToFile

public static void inputStreamToFile(@NotNull
                                     InputStream in,
                                     @NotNull
                                     File outFile)
                              throws IOException

Read data from input stream in and write to outFile file.

Parameters:

in - source

outFile - target

Throws:

IOException

streamCopy

public static void streamCopy(InputStream inputStream,
                              OutputStream outputStream)
                       throws IOException

Throws:

IOException

resourceToFile

public static void resourceToFile(ClassLoader classLoader,
                                  String resourcePath,
                                  File outputFile)
                           throws IOException

Copy resourcePath resource using classLoader to outputFile.

Throws:

IOException

deltree

public static boolean deltree(File rootDir)

delete a file, or directory and all of its contents

Parameters:

rootDir - the file or directory to start at

Returns:

success of the operation

getNormalizedPath

public static String getNormalizedPath(String inputPath)

Converts all backslashes to forward-slashes, so that Unix-style file separator is used.

Returns:

normalized path (or null if inputPath is null)

getPlatformSpecificPath

public static String getPlatformSpecificPath(String inputPath)

Converts all forward-slashes and back-slashes to a platform-specific file separator (i.e. '/' on Unix, '\' on Windows). The File.separatorChar is used.

Returns:

converted path (or null if inputPath is null)

getRelativePath

public static String getRelativePath(String a,
                                     String b,
                                     String pathSep)

getRelativePath

public static String getRelativePath(String a,
                                     String b)

getRelativePath

public static String getRelativePath(File a,
                                     File b,
                                     String pathSep)

getRelativePath

public static String getRelativePath(File a,
                                     File b)

calcAdlerChecksum

public static long calcAdlerChecksum(File f,
                                     String encoding)
                              throws IOException

Throws:

IOException

isAncestorOf

public static boolean isAncestorOf(File a,
                                   File b)

fromURI

public static String fromURI(String uri)

*** stolen from Apache Ant 1.6 Constructs a file path from a file: URI.

Will be an absolute path if the given URI is absolute.

Swallows '%' that are not followed by two characters, doesn't deal with non-ASCII characters.

Parameters:

uri - the URI designating a file in the local filesystem.

Returns:

the local file system path for the file.

Since:

Ant 1.6

compareLastModified

public int compareLastModified(long date,
                               File file)

Compares a given date with the last modified date of a file, taking into account the filesystem resolution for file dates available on the current platform.

Returns:

0 if the date and the last modified date match or are close enough that they could match given the platform fs date resolution, -1 if the file is newer than the date or 1 if the file is older.

listMatchingFilesForDir

public static File[] listMatchingFilesForDir(File dir,
                                             String regex)
                                      throws IOException

Lists only the files, not the directories for a given directory.

Parameters:

dir - the dir to list files of

regex - filenames must match this

Returns:

an array of all files in the given dir

Throws:

IOException - if the dir cannot be read

createTempDir

public static File createTempDir(String name)
                          throws IOException

Throws:

IOException

createTempDir

public static File createTempDir(String name,
                                 File parent)
                          throws IOException

Throws:

IOException

createEmptyDir

public static File createEmptyDir(File parent,
                                  String name)

readChars

public static String readChars(DataInputStream in)
                        throws IOException

Throws:

IOException

getCurrentDirIfNull

public static File getCurrentDirIfNull(File dir)

Returns:

new File(".") if dir is null