Class Mojo
- java.lang.Object
-
- org.apache.maven.tools.plugin.extractor.model.Mojo
-
- All Implemented Interfaces:
java.io.Serializable
public class Mojo extends java.lang.Object implements java.io.Serializable
Mojo descriptor definition.- Version:
- $Revision$ $Date$
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
aggregator
Whether this mojo operates as an aggregator when the reactor is run.private java.lang.String
call
The target/method within the script to call when this mojo executes.private java.util.List<Component>
components
Field components.private java.lang.String
deprecation
A deprecation message for this mojo parameter.private java.lang.String
description
The description for this parameter.private LifecycleExecution
execution
Information about a sub-execution of the Maven lifecycle which should be processed.private java.lang.String
goal
The name of the goal used to invoke this mojo.private boolean
inheritByDefault
Whether this mojo's configuration should propagate down the POM inheritance chain by default.private java.util.List<Parameter>
parameters
Field parameters.private java.lang.String
phase
The phase to which this mojo should be bound by default.private java.lang.String
requiresDependencyResolution
The scope of dependencies that this mojo requires to have resolved.private boolean
requiresDirectInvocation
If true, this mojo can only be directly invoked (eg.private boolean
requiresOnline
Whether this mojo requires online mode to operate normally.private boolean
requiresProject
Whether this mojo requires a project instance in order to execute.private boolean
requiresReports
Whether this mojo requires a reports section in the POM.private java.lang.String
since
Version when the mojo was added to the API.
-
Constructor Summary
Constructors Constructor Description Mojo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addComponent(Component component)
Method addComponent.void
addParameter(Parameter parameter)
Method addParameter.java.lang.String
getCall()
Get the target/method within the script to call when this mojo executes.java.util.List<Component>
getComponents()
Method getComponents.java.lang.String
getDeprecation()
Get a deprecation message for this mojo parameter.java.lang.String
getDescription()
Get the description for this parameter.LifecycleExecution
getExecution()
Get information about a sub-execution of the Maven lifecycle which should be processed.java.lang.String
getGoal()
Get the name of the goal used to invoke this mojo.java.util.List<Parameter>
getParameters()
Method getParameters.java.lang.String
getPhase()
Get the phase to which this mojo should be bound by default.java.lang.String
getRequiresDependencyResolution()
Get the scope of dependencies that this mojo requires to have resolved.java.lang.String
getSince()
Get version when the mojo was added to the API.boolean
isAggregator()
Get whether this mojo operates as an aggregator when the reactor is run.boolean
isInheritByDefault()
Get whether this mojo's configuration should propagate down the POM inheritance chain by default.boolean
isRequiresDirectInvocation()
Get if true, this mojo can only be directly invoked (eg.boolean
isRequiresOnline()
Get whether this mojo requires online mode to operate normally.boolean
isRequiresProject()
Get whether this mojo requires a project instance in order to execute.boolean
isRequiresReports()
Get whether this mojo requires a reports section in the POM.void
removeComponent(Component component)
Method removeComponent.void
removeParameter(Parameter parameter)
Method removeParameter.void
setAggregator(boolean aggregator)
Set whether this mojo operates as an aggregator when the reactor is run.void
setCall(java.lang.String call)
Set the target/method within the script to call when this mojo executes.void
setComponents(java.util.List<Component> components)
Set list of plexus components required by this mojo.void
setDeprecation(java.lang.String deprecation)
Set a deprecation message for this mojo parameter.void
setDescription(java.lang.String description)
Set the description for this parameter.void
setExecution(LifecycleExecution execution)
Set information about a sub-execution of the Maven lifecycle which should be processed.void
setGoal(java.lang.String goal)
Set the name of the goal used to invoke this mojo.void
setInheritByDefault(boolean inheritByDefault)
Set whether this mojo's configuration should propagate down the POM inheritance chain by default.void
setParameters(java.util.List<Parameter> parameters)
Set list of parameters used by this mojo.void
setPhase(java.lang.String phase)
Set the phase to which this mojo should be bound by default.void
setRequiresDependencyResolution(java.lang.String requiresDependencyResolution)
Set the scope of dependencies that this mojo requires to have resolved.void
setRequiresDirectInvocation(boolean requiresDirectInvocation)
Set if true, this mojo can only be directly invoked (eg.void
setRequiresOnline(boolean requiresOnline)
Set whether this mojo requires online mode to operate normally.void
setRequiresProject(boolean requiresProject)
Set whether this mojo requires a project instance in order to execute.void
setRequiresReports(boolean requiresReports)
Set whether this mojo requires a reports section in the POM.void
setSince(java.lang.String since)
Set version when the mojo was added to the API.
-
-
-
Field Detail
-
goal
private java.lang.String goal
The name of the goal used to invoke this mojo.
-
phase
private java.lang.String phase
The phase to which this mojo should be bound by default.
-
aggregator
private boolean aggregator
Whether this mojo operates as an aggregator when the reactor is run. That is, only runs once.
-
requiresDependencyResolution
private java.lang.String requiresDependencyResolution
The scope of dependencies that this mojo requires to have resolved.
-
requiresProject
private boolean requiresProject
Whether this mojo requires a project instance in order to execute.
-
requiresReports
private boolean requiresReports
Whether this mojo requires a reports section in the POM.
-
requiresOnline
private boolean requiresOnline
Whether this mojo requires online mode to operate normally.
-
inheritByDefault
private boolean inheritByDefault
Whether this mojo's configuration should propagate down the POM inheritance chain by default.
-
requiresDirectInvocation
private boolean requiresDirectInvocation
If true, this mojo can only be directly invoked (eg. specified directly on the command line).
-
execution
private LifecycleExecution execution
Information about a sub-execution of the Maven lifecycle which should be processed.
-
components
private java.util.List<Component> components
Field components.
-
parameters
private java.util.List<Parameter> parameters
Field parameters.
-
description
private java.lang.String description
The description for this parameter.
-
deprecation
private java.lang.String deprecation
A deprecation message for this mojo parameter.
-
since
private java.lang.String since
Version when the mojo was added to the API.
-
call
private java.lang.String call
The target/method within the script to call when this mojo executes.
-
-
Method Detail
-
addComponent
public void addComponent(Component component)
Method addComponent.- Parameters:
component
-
-
addParameter
public void addParameter(Parameter parameter)
Method addParameter.- Parameters:
parameter
-
-
getCall
public java.lang.String getCall()
Get the target/method within the script to call when this mojo executes.- Returns:
- String
-
getComponents
public java.util.List<Component> getComponents()
Method getComponents.- Returns:
- List
-
getDeprecation
public java.lang.String getDeprecation()
Get a deprecation message for this mojo parameter.- Returns:
- String
-
getDescription
public java.lang.String getDescription()
Get the description for this parameter.- Returns:
- String
-
getExecution
public LifecycleExecution getExecution()
Get information about a sub-execution of the Maven lifecycle which should be processed.- Returns:
- LifecycleExecution
-
getGoal
public java.lang.String getGoal()
Get the name of the goal used to invoke this mojo.- Returns:
- String
-
getParameters
public java.util.List<Parameter> getParameters()
Method getParameters.- Returns:
- List
-
getPhase
public java.lang.String getPhase()
Get the phase to which this mojo should be bound by default.- Returns:
- String
-
getRequiresDependencyResolution
public java.lang.String getRequiresDependencyResolution()
Get the scope of dependencies that this mojo requires to have resolved.- Returns:
- String
-
getSince
public java.lang.String getSince()
Get version when the mojo was added to the API.- Returns:
- String
-
isAggregator
public boolean isAggregator()
Get whether this mojo operates as an aggregator when the reactor is run. That is, only runs once.- Returns:
- boolean
-
isInheritByDefault
public boolean isInheritByDefault()
Get whether this mojo's configuration should propagate down the POM inheritance chain by default.- Returns:
- boolean
-
isRequiresDirectInvocation
public boolean isRequiresDirectInvocation()
Get if true, this mojo can only be directly invoked (eg. specified directly on the command line).- Returns:
- boolean
-
isRequiresOnline
public boolean isRequiresOnline()
Get whether this mojo requires online mode to operate normally.- Returns:
- boolean
-
isRequiresProject
public boolean isRequiresProject()
Get whether this mojo requires a project instance in order to execute.- Returns:
- boolean
-
isRequiresReports
public boolean isRequiresReports()
Get whether this mojo requires a reports section in the POM.- Returns:
- boolean
-
removeComponent
public void removeComponent(Component component)
Method removeComponent.- Parameters:
component
-
-
removeParameter
public void removeParameter(Parameter parameter)
Method removeParameter.- Parameters:
parameter
-
-
setAggregator
public void setAggregator(boolean aggregator)
Set whether this mojo operates as an aggregator when the reactor is run. That is, only runs once.- Parameters:
aggregator
-
-
setCall
public void setCall(java.lang.String call)
Set the target/method within the script to call when this mojo executes.- Parameters:
call
-
-
setComponents
public void setComponents(java.util.List<Component> components)
Set list of plexus components required by this mojo.- Parameters:
components
-
-
setDeprecation
public void setDeprecation(java.lang.String deprecation)
Set a deprecation message for this mojo parameter.- Parameters:
deprecation
-
-
setDescription
public void setDescription(java.lang.String description)
Set the description for this parameter.- Parameters:
description
-
-
setExecution
public void setExecution(LifecycleExecution execution)
Set information about a sub-execution of the Maven lifecycle which should be processed.- Parameters:
execution
-
-
setGoal
public void setGoal(java.lang.String goal)
Set the name of the goal used to invoke this mojo.- Parameters:
goal
-
-
setInheritByDefault
public void setInheritByDefault(boolean inheritByDefault)
Set whether this mojo's configuration should propagate down the POM inheritance chain by default.- Parameters:
inheritByDefault
-
-
setParameters
public void setParameters(java.util.List<Parameter> parameters)
Set list of parameters used by this mojo.- Parameters:
parameters
-
-
setPhase
public void setPhase(java.lang.String phase)
Set the phase to which this mojo should be bound by default.- Parameters:
phase
-
-
setRequiresDependencyResolution
public void setRequiresDependencyResolution(java.lang.String requiresDependencyResolution)
Set the scope of dependencies that this mojo requires to have resolved.- Parameters:
requiresDependencyResolution
-
-
setRequiresDirectInvocation
public void setRequiresDirectInvocation(boolean requiresDirectInvocation)
Set if true, this mojo can only be directly invoked (eg. specified directly on the command line).- Parameters:
requiresDirectInvocation
-
-
setRequiresOnline
public void setRequiresOnline(boolean requiresOnline)
Set whether this mojo requires online mode to operate normally.- Parameters:
requiresOnline
-
-
setRequiresProject
public void setRequiresProject(boolean requiresProject)
Set whether this mojo requires a project instance in order to execute.- Parameters:
requiresProject
-
-
setRequiresReports
public void setRequiresReports(boolean requiresReports)
Set whether this mojo requires a reports section in the POM.- Parameters:
requiresReports
-
-
setSince
public void setSince(java.lang.String since)
Set version when the mojo was added to the API.- Parameters:
since
-
-
-