com.helger.commons.io.file

Class FileOperationManager

java.lang.Object

com.helger.commons.io.file.FileOperationManager

All Implemented Interfaces:

IFileOperationManager, Serializable

@NotThreadSafe
public class FileOperationManager
extends Object
implements IFileOperationManager

Manage file operations, and persist the last errors for later retrieval, as well as offering a callback mechanism for success/error handling.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static IFileOperationManager	INSTANCE

Constructor Summary

Constructors

Constructor and Description
FileOperationManager()

Method Summary

Modifier and Type	Method and Description
CallbackList<IFileOperationCallback>	callbacks()
FileIOError	copyDirRecursive(File aSourceDir, File aTargetDir) Copy a directory including all child objects.
FileIOError	copyFile(File aSourceFile, File aTargetFile) Copies the source file to the target file.
FileIOError	createDir(File aDir) Create a new directory.
FileIOError	createDirIfNotExisting(File aDir) Create a new directory if it does not exist.
FileIOError	createDirRecursive(File aDir) Create a new directory.
FileIOError	createDirRecursiveIfNotExisting(File aDir) Create a new directory if it does not exist.
FileIOError	deleteDir(File aDir) Delete an existing directory.
FileIOError	deleteDirIfExisting(File aDir) Delete an existing directory if it is existing.
FileIOError	deleteDirRecursive(File aDir) Delete an existing directory including all child objects.
FileIOError	deleteDirRecursiveIfExisting(File aDir) Delete an existing directory including all child objects if it is existing.
FileIOError	deleteFile(File aFile) Delete an existing file.
FileIOError	deleteFileIfExisting(File aFile) Delete a file if it is existing.
FileIOError	getLastError()
EFileIOOperation	getLastOperation()
FileIOError	renameDir(File aSourceDir, File aTargetDir) Rename a directory.
FileIOError	renameFile(File aSourceFile, File aTargetFile) Rename a file.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final IFileOperationManager INSTANCE

Constructor Detail

FileOperationManager

public FileOperationManager()

Method Detail

callbacks

@Nonnull
 @ReturnsMutableObject
public CallbackList<IFileOperationCallback> callbacks()

getLastError

@Nullable
public FileIOError getLastError()

Specified by:

getLastError in interface IFileOperationManager

Returns:

The last error that occurred. May be null if no action was yet performed.

getLastOperation

@Nullable
public EFileIOOperation getLastOperation()

Specified by:

getLastOperation in interface IFileOperationManager

Returns:

The last operation that was executed, independent of error or success. May be null if no action was performed yet.

createDir

@Nonnull
public FileIOError createDir(@Nonnull
                                       File aDir)

Description copied from interface: IFileOperationManager

Create a new directory. The direct parent directory already needs to exist.

Specified by:

createDir in interface IFileOperationManager

Parameters:

aDir - The directory to be created. May not be null.

Returns:

A non-null error code.

createDirIfNotExisting

@Nonnull
public FileIOError createDirIfNotExisting(@Nonnull
                                                    File aDir)

Description copied from interface: IFileOperationManager

Create a new directory if it does not exist. The direct parent directory already needs to exist.

Specified by:

createDirIfNotExisting in interface IFileOperationManager

Parameters:

aDir - The directory to be created if it does not exist. May not be null.

Returns:

A non-null error code.

createDirRecursive

@Nonnull
public FileIOError createDirRecursive(@Nonnull
                                                File aDir)

Description copied from interface: IFileOperationManager

Create a new directory. The parent directories are created if they are missing.

Specified by:

createDirRecursive in interface IFileOperationManager

Parameters:

aDir - The directory to be created. May not be null.

Returns:

A non-null error code.

createDirRecursiveIfNotExisting

@Nonnull
public FileIOError createDirRecursiveIfNotExisting(@Nonnull
                                                             File aDir)

Description copied from interface: IFileOperationManager

Create a new directory if it does not exist. The direct parent directory already needs to exist.

Specified by:

createDirRecursiveIfNotExisting in interface IFileOperationManager

Parameters:

aDir - The directory to be created if it does not exist. May not be null.

Returns:

A non-null error code.

deleteDir

@Nonnull
public FileIOError deleteDir(@Nonnull
                                       File aDir)

Description copied from interface: IFileOperationManager

Delete an existing directory. The directory needs to be empty before it can be deleted.

Specified by:

deleteDir in interface IFileOperationManager

Parameters:

aDir - The directory to be deleted. May not be null.

Returns:

A non-null error code.

deleteDirIfExisting

@Nonnull
public FileIOError deleteDirIfExisting(@Nonnull
                                                 File aDir)

Description copied from interface: IFileOperationManager

Delete an existing directory if it is existing. The directory needs to be empty before it can be deleted.

Specified by:

deleteDirIfExisting in interface IFileOperationManager

Parameters:

aDir - The directory to be deleted. May not be null.

Returns:

A non-null error code.

deleteDirRecursive

@Nonnull
public FileIOError deleteDirRecursive(@Nonnull
                                                File aDir)

Description copied from interface: IFileOperationManager

Delete an existing directory including all child objects.

Specified by:

deleteDirRecursive in interface IFileOperationManager

Parameters:

aDir - The directory to be deleted. May not be null.

Returns:

A non-null error code.

deleteDirRecursiveIfExisting

@Nonnull
public FileIOError deleteDirRecursiveIfExisting(@Nonnull
                                                          File aDir)

Description copied from interface: IFileOperationManager

Delete an existing directory including all child objects if it is existing.

Specified by:

deleteDirRecursiveIfExisting in interface IFileOperationManager

Parameters:

aDir - The directory to be deleted. May not be null.

Returns:

A non-null error code.

deleteFile

@Nonnull
public FileIOError deleteFile(@Nonnull
                                        File aFile)

Description copied from interface: IFileOperationManager

Delete an existing file.

Specified by:

deleteFile in interface IFileOperationManager

Parameters:

aFile - The file to be deleted. May not be null.

Returns:

A non-null error code.

deleteFileIfExisting

@Nonnull
public FileIOError deleteFileIfExisting(@Nonnull
                                                  File aFile)

Description copied from interface: IFileOperationManager

Delete a file if it is existing.

Specified by:

deleteFileIfExisting in interface IFileOperationManager

Parameters:

aFile - The file to be deleted. May not be null.

Returns:

A non-null error code.

renameDir

@Nonnull
public FileIOError renameDir(@Nonnull
                                       File aSourceDir,
                                       @Nonnull
                                       File aTargetDir)

Description copied from interface: IFileOperationManager

Rename a directory.

Specified by:

renameDir in interface IFileOperationManager

Parameters:

aSourceDir - The original directory name. May not be null.

aTargetDir - The destination directory name. May not be null.

Returns:

A non-null error code.

renameFile

@Nonnull
public FileIOError renameFile(@Nonnull
                                        File aSourceFile,
                                        @Nonnull
                                        File aTargetFile)

Description copied from interface: IFileOperationManager

Rename a file.

Specified by:

renameFile in interface IFileOperationManager

Parameters:

aSourceFile - The original file name. May not be null.

aTargetFile - The destination file name. May not be null.

Returns:

A non-null error code.

copyDirRecursive

@Nonnull
public FileIOError copyDirRecursive(@Nonnull
                                              File aSourceDir,
                                              @Nonnull
                                              File aTargetDir)

Description copied from interface: IFileOperationManager

Copy a directory including all child objects.

Specified by:

copyDirRecursive in interface IFileOperationManager

Parameters:

aSourceDir - The source directory to be copied. May not be null.

aTargetDir - The destination directory where to be copied. This directory may not be existing. May not be null.

Returns:

A non-null error code.

copyFile

@Nonnull
public FileIOError copyFile(@Nonnull
                                      File aSourceFile,
                                      @Nonnull
                                      File aTargetFile)

Description copied from interface: IFileOperationManager

Copies the source file to the target file.

Specified by:

copyFile in interface IFileOperationManager

Parameters:

aSourceFile - The source file to use. May not be null. Needs to be an existing file.

aTargetFile - The destination files. May not be null and may not be an existing file.

Returns:

A non-null error code.

toString

public String toString()

Overrides:

toString in class Object