Package org.apache.maven.plugins.clean

Class CleanMojo

java.lang.Object

org.apache.maven.plugins.clean.CleanMojo

All Implemented Interfaces:

org.apache.maven.api.plugin.Mojo

@Mojo(name="clean")
public class CleanMojo
extends Object
implements org.apache.maven.api.plugin.Mojo

Goal which cleans the build.

This attempts to clean a project's working directory of the files that were generated at build-time. By default, it discovers and deletes the directories configured in project.build.directory, project.build.outputDirectory, project.build.testOutputDirectory, and project.reporting.outputDirectory.

Files outside the default may also be included in the deletion by configuring the filesets tag.

Since:

2.0

Author:

Emmanuel Venisse

See Also:

• Fileset

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FAST_MODE_AT_END
static final String	FAST_MODE_BACKGROUND
static final String	FAST_MODE_DEFER

Constructor Summary

Constructors

Constructor	Description
CleanMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()	Deletes file-sets in the following project build directory order: (source) directory, output directory, test directory, report directory, and then the additional file-sets.

Methods inherited from class java.lang.Object

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

Field Details

FAST_MODE_BACKGROUND

public static final String FAST_MODE_BACKGROUND

See Also:

• Constant Field Values

FAST_MODE_AT_END

public static final String FAST_MODE_AT_END

See Also:

• Constant Field Values

FAST_MODE_DEFER

public static final String FAST_MODE_DEFER

See Also:

• Constant Field Values

Constructor Details

CleanMojo

public CleanMojo()

Method Details

execute

public void execute()

Deletes file-sets in the following project build directory order: (source) directory, output directory, test directory, report directory, and then the additional file-sets.

Specified by:

execute in interface org.apache.maven.api.plugin.Mojo

Throws:

org.apache.maven.api.plugin.MojoException - When a directory failed to get deleted.

See Also:

• Mojo.execute()