Module io.github.astrapisixtynine.file.worker

Package io.github.astrapi69.file.delete

Class DeleteFileExtensions

java.lang.Object

io.github.astrapi69.file.delete.DeleteFileExtensions

public final class DeleteFileExtensions
extends Object

The class DeleteFileExtensions helps you delete files.

Method Summary

Modifier and Type	Method	Description
static Exception	checkFile(File file)	Checks the File if it is a directory or if its exists or if it is empty.
static boolean	delete(File file)	Tries to delete the given File object and if it's a directory than it will try to delete all the subdirectories
static void	delete(Collection<File> files)	Tries to delete all given files in the list.
static void	deleteAllFiles(File file)	Deletes the File and if it is an directory it deletes his sub-directories recursively.
static void	deleteAllFilesWithPrefix(File sourceDir, String prefix)	Tries to delete all files that match to the given prefix from the given source directory.
static void	deleteAllFilesWithSuffix(File file, String theSuffix)	Deletes all files with the given suffix recursively.
static void	deleteFile(File fileToDelete)	Tries to delete the given file.
static void	deleteFiles(File file)	Tries to delete all files in the Directory.
static void	deleteFilesWithFileFilter(File sourceDir, FileFilter includeFileFilter)	Tries to delete all files that match to the given includeFileFilter from the given source directory.
static void	deleteFilesWithFileFilter(File source, FileFilter includeFileFilter, FileFilter excludeFileFilter)	Tries to delete all files that match to the given includeFileFilter and does not delete the files that match the excludeFileFilter from the given source directory.
static void	deleteFilesWithFilenameFilter(File source, FilenameFilter includeFilenameFilter)	Tries to delete all files that match to the given includeFilenameFilter from the given source directory.
static void	deleteFilesWithFilenameFilter(File source, FilenameFilter includeFilenameFilter, FilenameFilter excludeFilenameFilter)	Tries to delete all files that match to the given includeFilenameFilter and does not delete the files that match the excludeFilenameFilter from the given source directory.

Methods inherited from class java.lang.Object

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

Method Details

checkFile

public static Exception checkFile(File file)

Checks the File if it is a directory or if its exists or if it is empty.

Parameters:

file - The File to check.

Returns:

Null if nothing is wrong otherwise an Exception.

delete

public static void delete(Collection<File> files)
                   throws IOException

Tries to delete all given files in the list. Caution: This can not be undone.

Parameters:

files - The files to delete.

Throws:

IOException - Signals that an I/O exception has occurred.

delete

public static boolean delete(File file)
                      throws IOException

Tries to delete the given File object and if it's a directory than it will try to delete all the subdirectories

Parameters:

file - The File object to delete

Returns:

true if the file or directory is deleted otherwise false

Throws:

IOException - Signals that an I/O exception has occurred.

deleteAllFiles

public static void deleteAllFiles(File file)
                           throws IOException

Deletes the File and if it is an directory it deletes his sub-directories recursively.

Parameters:

file - The File to delete.

Throws:

IOException - Signals that an I/O exception has occurred.

deleteAllFilesWithSuffix

public static void deleteAllFilesWithSuffix(File file,
 String theSuffix)
                                     throws IOException

Deletes all files with the given suffix recursively.

Parameters:

file - The directory from where to delete the files wiht the given suffix.

theSuffix - The suffix from the files to delete.

Throws:

IOException - Signals that an I/O exception has occurred.

deleteFile

public static void deleteFile(File fileToDelete)
                       throws IOException

Tries to delete the given file.

Parameters:

fileToDelete - The file to delete.

Throws:

IOException - Signals that an I/O exception has occurred.

deleteFiles

public static void deleteFiles(File file)
                        throws IOException

Tries to delete all files in the Directory.

Parameters:

file - The Directory to delete files.

Throws:

IOException - Signals that an I/O exception has occurred.

deleteFilesWithFileFilter

public static void deleteFilesWithFileFilter(File sourceDir,
 FileFilter includeFileFilter)
                                      throws FileIsNotADirectoryException,
IOException,
FileIsSecurityRestrictedException

Tries to delete all files that match to the given includeFileFilter from the given source directory.

Parameters:

sourceDir - The source directory.

includeFileFilter - The FileFilter for the files to be deleted. If null all files will be deleted.

Throws:

FileIsNotADirectoryException - Is thrown if the destination file is a directory.

IOException - Is thrown if an error occurs by reading or writing.

FileIsSecurityRestrictedException - Is thrown if the source file is security restricted.

deleteAllFilesWithPrefix

public static void deleteAllFilesWithPrefix(File sourceDir,
 String prefix)
                                     throws FileIsNotADirectoryException,
FileIsSecurityRestrictedException,
IOException

Tries to delete all files that match to the given prefix from the given source directory.

Parameters:

sourceDir - The source directory

prefix - The prefix from the files to delete

Throws:

FileIsNotADirectoryException - Is thrown if the destination file is a directory.

IOException - Is thrown if an error occurs by reading or writing.

FileIsSecurityRestrictedException - Is thrown if the source file is security restricted.

deleteFilesWithFileFilter

public static void deleteFilesWithFileFilter(File source,
 FileFilter includeFileFilter,
 FileFilter excludeFileFilter)
                                      throws FileIsNotADirectoryException,
IOException,
FileIsSecurityRestrictedException

Tries to delete all files that match to the given includeFileFilter and does not delete the files that match the excludeFileFilter from the given source directory.

Parameters:

source - The source directory.

includeFileFilter - The FileFilter for the files to be deleted. If null all files will be deleted.

excludeFileFilter - The FileFilter for the files to be not deleted. If null no files will be excluded by delete process.

Throws:

FileIsNotADirectoryException - Is thrown if the destination file is a directory.

IOException - Is thrown if an error occurs by reading or writing.

FileIsSecurityRestrictedException - Is thrown if the source file is security restricted.

deleteFilesWithFilenameFilter

public static void deleteFilesWithFilenameFilter(File source,
 FilenameFilter includeFilenameFilter)
                                          throws FileIsNotADirectoryException,
IOException,
FileIsSecurityRestrictedException

Tries to delete all files that match to the given includeFilenameFilter from the given source directory.

Parameters:

source - The source directory.

includeFilenameFilter - The FilenameFilter for the files to be deleted. If null all files will be deleted.

Throws:

FileIsNotADirectoryException - Is thrown if the destination file is a directory.

IOException - Is thrown if an error occurs by reading or writing.

FileIsSecurityRestrictedException - Is thrown if the source file is security restricted.

deleteFilesWithFilenameFilter

public static void deleteFilesWithFilenameFilter(File source,
 FilenameFilter includeFilenameFilter,
 FilenameFilter excludeFilenameFilter)
                                          throws FileIsNotADirectoryException,
IOException,
FileIsSecurityRestrictedException

Tries to delete all files that match to the given includeFilenameFilter and does not delete the files that match the excludeFilenameFilter from the given source directory.

Parameters:

source - The source directory.

includeFilenameFilter - The FilenameFilter for the files to be deleted. If null all files will be deleted.

excludeFilenameFilter - The FilenameFilter for the files to be not deleted. If null no files will be excluded by delete process.

Throws:

FileIsNotADirectoryException - Is thrown if the destination file is a directory.

IOException - Is thrown if an error occurs by reading or writing.

FileIsSecurityRestrictedException - Is thrown if the source file is security restricted.