org.codehaus.mojo.license.utils

Class FileUtil

java.lang.Object

org.codehaus.mojo.license.utils.FileUtil

public class FileUtil
extends Object

Some basic file io utilities

Since:

1.0

Author:

pgier, tchemit dev@tchemit.fr

Constructor Summary

Constructors

Constructor and Description
FileUtil()

Method Summary

Modifier and Type	Method and Description
static void	backupFile(File f) Backups the given file using the getBackupFile(File) as destination file.
static void	copyFile(File source, File target) Copy a file to a given locationand logging.
static boolean	createDirectoryIfNecessary(File dir) Creates the directory (and his parents) if necessary.
static boolean	createNewFile(File file)
static void	deleteFile(File file) Delete the given file.
static File	getBackupFile(File file)
static File	getFile(File base, String... paths)
static List<File>	orderFiles(Collection<File> files)
static void	printString(File file, String content, String encoding) Print content to file.
static String	readAsString(File file, String encoding) Permet de lire un fichier et de retourner sont contenu sous forme d'une chaine de carateres.
static void	renameFile(File file, File destination) Rename the given file to a new destination.
static void	tryClose(InputStream is)
static void	tryClose(OutputStream os)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUtil

public FileUtil()

Method Detail

tryClose

public static void tryClose(InputStream is)

tryClose

public static void tryClose(OutputStream os)

createDirectoryIfNecessary

public static boolean createDirectoryIfNecessary(File dir)
                                          throws IOException

Creates the directory (and his parents) if necessary.

Parameters:

dir - the directory to create if not exisiting

Returns:

true if directory was created, false if was no need to create it

Throws:

IOException - if could not create directory

createNewFile

public static boolean createNewFile(File file)
                             throws IOException

Throws:

IOException

deleteFile

public static void deleteFile(File file)
                       throws IOException

Delete the given file.

Parameters:

file - the file to delete

Throws:

IOException - if could not delete the file

renameFile

public static void renameFile(File file,
                              File destination)
                       throws IOException

Rename the given file to a new destination.

Parameters:

file - the file to rename

destination - the destination file

Throws:

IOException - if could not rename the file

copyFile

public static void copyFile(File source,
                            File target)
                     throws IOException

Copy a file to a given locationand logging.

Parameters:

source - represents the file to copy.

target - file name of destination file.

Throws:

IOException - if could not copy file.

getFile

public static File getFile(File base,
                           String... paths)

getBackupFile

public static File getBackupFile(File file)

Parameters:

file - the source file

Returns:

the backup file

backupFile

public static void backupFile(File f)
                       throws IOException

Backups the given file using the getBackupFile(File) as destination file.

Parameters:

f - the file to backup

Throws:

IOException - if any pb while copying the file

readAsString

public static String readAsString(File file,
                                  String encoding)
                           throws IOException

Permet de lire un fichier et de retourner sont contenu sous forme d'une chaine de carateres.

Parameters:

file - le fichier a lire

encoding - encoding to read file

Returns:

the content of the file

Throws:

IOException - if IO pb

printString

public static void printString(File file,
                               String content,
                               String encoding)
                        throws IOException

Print content to file. This method ensures that a platform specific line ending is used.

Parameters:

file - the file to write to

content - the content to write

encoding - the encoding to write in

Throws:

IOException - if IO pb

orderFiles

public static List<File> orderFiles(Collection<File> files)