de.mrapp.util

Class FileUtil

java.lang.Object

de.mrapp.util.FileUtil

public final class FileUtil
extends java.lang.Object

An utility class, which provides static methods, which allow to handle files.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
static void	createNewFile(@NotNull java.io.File file) Creates a new, empty file.
static void	createNewFile(@NotNull java.io.File file, boolean overwrite) Creates a new, empty file.
static void	delete(@NotNull java.io.File file) Deletes a specific file.
static void	deleteRecursively(@NotNull java.io.File file) Deletes a specific file or directory.
static void	mkdir(@NotNull java.io.File directory) Creates a specific directory, if it does not already exist.
static void	mkdirs(@NotNull java.io.File directory) Creates a specific directory, if it does not already exist.

Methods inherited from class java.lang.Object

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

Method Detail

mkdir

public static void mkdir(@NotNull
                         @NotNull java.io.File directory)
                  throws java.io.IOException

Creates a specific directory, if it does not already exist. It is assumed, that the parent directories already exist. If the parent directories should be created as well, use the mkdirs-method instead.

Parameters:

directory - The directory, which should be created, as an instance of the class File. The directory may not be null

Throws:

java.io.IOException - The exception, which is thrown, if an error occurred while creating the directory

mkdirs

public static void mkdirs(@NotNull
                          @NotNull java.io.File directory)
                   throws java.io.IOException

Creates a specific directory, if it does not already exist. If necessary the parent directories are created as well. If no parent directories should be created, use the mkdir-method instead.

Parameters:

directory - The directory, which should be created, as an instance of the class File. The directory may not be null

Throws:

java.io.IOException - The exception, which is thrown, if an error occurred while creating the directory

delete

public static void delete(@NotNull
                          @NotNull java.io.File file)
                   throws java.io.IOException

Deletes a specific file. If a directory and its contents should be deleted, use the deleteRecursively-method instead.

Parameters:

file - The file, which should be deleted, as an instance of the class File. The file may not be null

Throws:

java.io.IOException - The exception, which is thrown, if an error occurred while deleting the file

deleteRecursively

public static void deleteRecursively(@NotNull
                                     @NotNull java.io.File file)
                              throws java.io.IOException

Deletes a specific file or directory. If the file is a directory, all contained files and subdirectories are deleted recursively.

Parameters:

file - The file or directory, which should be deleted, as an instance of the class File. The file or directory may not be null

Throws:

java.io.IOException - The exception, which is thrown, if an error occurs while deleting the file or directory

createNewFile

public static void createNewFile(@NotNull
                                 @NotNull java.io.File file)
                          throws java.io.IOException

Creates a new, empty file.

Parameters:

file - The file, which should be created, as an instance of the class File. The file may not be null. If the file is a directory, an IllegalArgumentException will be thrown

Throws:

java.io.IOException - The exception, which is thrown, if an error occurs while creating the file

createNewFile

public static void createNewFile(@NotNull
                                 @NotNull java.io.File file,
                                 boolean overwrite)
                          throws java.io.IOException

Creates a new, empty file.

Parameters:

file - The file, which should be created, as an instance of the class File. The file may not be null. If the file is a directory, an IllegalArgumentException will be thrown

overwrite - True, if the file should be overwritten, if it does already exist, false otherwise

Throws:

java.io.IOException - The exception, which is thrown, if an error occurs while creating the file