Package org.apache.maven.plugins.clean
Class Cleaner
- java.lang.Object
-
- org.apache.maven.plugins.clean.Cleaner
-
class Cleaner extends java.lang.Object
Cleans directories.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static interface
Cleaner.Logger
private static class
Cleaner.Result
-
Field Summary
Fields Modifier and Type Field Description private Cleaner.Logger
logDebug
private Cleaner.Logger
logInfo
private Cleaner.Logger
logVerbose
private Cleaner.Logger
logWarn
private static boolean
ON_WINDOWS
-
Constructor Summary
Constructors Constructor Description Cleaner(org.apache.maven.plugin.logging.Log log, boolean verbose)
Creates a new cleaner.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private int
delete(java.io.File file, boolean failOnError, boolean retryOnError)
Deletes the specified file, directory.private Cleaner.Result
delete(java.io.File file, java.lang.String pathname, Selector selector, boolean followSymlinks, boolean failOnError, boolean retryOnError)
Deletes the specified file or directory.void
delete(java.io.File basedir, Selector selector, boolean followSymlinks, boolean failOnError, boolean retryOnError)
Deletes the specified directories and its contents.
-
-
-
Field Detail
-
ON_WINDOWS
private static final boolean ON_WINDOWS
-
logDebug
private final Cleaner.Logger logDebug
-
logInfo
private final Cleaner.Logger logInfo
-
logVerbose
private final Cleaner.Logger logVerbose
-
logWarn
private final Cleaner.Logger logWarn
-
-
Method Detail
-
delete
public void delete(java.io.File basedir, Selector selector, boolean followSymlinks, boolean failOnError, boolean retryOnError) throws java.io.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:
java.io.IOException
- If a file/directory could not be deleted andfailOnError
istrue
.
-
delete
private Cleaner.Result delete(java.io.File file, java.lang.String pathname, Selector selector, boolean followSymlinks, boolean failOnError, boolean retryOnError) throws java.io.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:
java.io.IOException
- If a file/directory could not be deleted andfailOnError
istrue
.
-
delete
private int delete(java.io.File file, boolean failOnError, boolean retryOnError) throws java.io.IOException
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:
java.io.IOException
- If a file/directory could not be deleted andfailOnError
istrue
.
-
-