Package org.apache.maven.plugin
Interface Mojo
- All Known Implementing Classes:
AbstractMojo
public interface Mojo
This interface forms the contract required for
It features an
Also included is the
Mojos
to interact with the Maven
infrastructure.It features an
execute()
method, which triggers the Mojo's build-process behavior, and can throw
a MojoExecutionException or MojoFailureException if error conditions occur.Also included is the
setLog(...)
method, which simply allows Maven to inject a logging mechanism which
will allow the Mojo to communicate to the outside world through standard Maven channels.- Author:
- Jason van Zyl
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
execute()
Perform whatever build-process behavior thisMojo
implements.
This is the main trigger for theMojo
inside theMaven
system, and allows theMojo
to communicate errors.getLog()
Furnish access to the standard Maven logging mechanism which is managed in this base class.void
Inject a standardMaven
logging mechanism to allow thisMojo
to communicate events and feedback to the user.
-
Field Details
-
ROLE
The componentrole
hint for Plexus container
-
-
Method Details
-
execute
Perform whatever build-process behavior thisMojo
implements.
This is the main trigger for theMojo
inside theMaven
system, and allows theMojo
to communicate errors.- Throws:
MojoExecutionException
- if an unexpected problem occurs. Throwing this exception causes a "BUILD ERROR" message to be displayed.MojoFailureException
- if an expected problem (such as a compilation failure) occurs. Throwing this exception causes a "BUILD FAILURE" message to be displayed.
-
setLog
Inject a standardMaven
logging mechanism to allow thisMojo
to communicate events and feedback to the user.- Parameters:
log
- a new logger
-
getLog
Log getLog()Furnish access to the standard Maven logging mechanism which is managed in this base class.- Returns:
- a log4j-like logger object which allows plugins to create messages at levels of
"debug"
,"info"
,"warn"
, and"error"
. This logger is the accepted means to display information to the user.
-