Package org.apache.maven.plugins.clean
Class Cleaner
java.lang.Object
org.apache.maven.plugins.clean.Cleaner
Cleans directories.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static interface
private static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Cleaner.Logger
private final Cleaner.Logger
private final Cleaner.Logger
private final Cleaner.Logger
private static final boolean
-
Constructor Summary
ConstructorsConstructorDescriptionCleaner
(org.apache.maven.plugin.logging.Log log, boolean verbose) Creates a new cleaner. -
Method Summary
Modifier and TypeMethodDescriptionprivate int
Deletes the specified file, directory.private Cleaner.Result
delete
(File file, String pathname, Selector selector, boolean followSymlinks, boolean failOnError, boolean retryOnError) Deletes the specified file or directory.void
delete
(File basedir, Selector selector, boolean followSymlinks, boolean failOnError, boolean retryOnError) Deletes the specified directories and its contents.
-
Field Details
-
ON_WINDOWS
private static final boolean ON_WINDOWS -
logDebug
-
logInfo
-
logVerbose
-
logWarn
-
-
Constructor Details
-
Cleaner
Cleaner(org.apache.maven.plugin.logging.Log log, boolean verbose) Creates a new cleaner.- Parameters:
log
- The logger to use, may benull
to disable logging.verbose
- Whether to perform verbose logging.
-
-
Method Details
-
delete
public void delete(File basedir, Selector selector, boolean followSymlinks, boolean failOnError, boolean retryOnError) throws IOException Deletes the specified directories and its contents.- Parameters:
basedir
- The directory to delete, must not benull
. Non-existing directories will be silently ignored.selector
- The selector used to determine what contents to delete, may benull
to delete everything.followSymlinks
- Whether to follow symlinks.failOnError
- Whether to abort with an exception in case a selected file/directory could not be deleted.retryOnError
- Whether to undertake additional delete attempts in case the first attempt failed.- Throws:
IOException
- If a file/directory could not be deleted andfailOnError
istrue
.
-
delete
private Cleaner.Result delete(File file, String pathname, Selector selector, boolean followSymlinks, boolean failOnError, boolean retryOnError) throws IOException Deletes the specified file or directory.- Parameters:
file
- The file/directory to delete, must not benull
. IffollowSymlinks
isfalse
, it is assumed that the parent file is canonical.pathname
- The relative pathname of the file, usingFile.separatorChar
, must not benull
.selector
- The selector used to determine what contents to delete, may benull
to delete everything.followSymlinks
- Whether to follow symlinks.failOnError
- Whether to abort with an exception in case a selected file/directory could not be deleted.retryOnError
- Whether to undertake additional delete attempts in case the first attempt failed.- Returns:
- The result of the cleaning, never
null
. - Throws:
IOException
- If a file/directory could not be deleted andfailOnError
istrue
.
-
delete
Deletes the specified file, directory. If the path denotes a symlink, only the link is removed, its target is left untouched.- Parameters:
file
- The file/directory to delete, must not benull
.failOnError
- Whether to abort with an exception in case the file/directory could not be deleted.retryOnError
- Whether to undertake additional delete attempts in case the first attempt failed.- Returns:
0
if the file was deleted,1
otherwise.- Throws:
IOException
- If a file/directory could not be deleted andfailOnError
istrue
.
-