public class Mojo
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and 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 and Description |
---|
Mojo() |
Modifier and Type | Method and 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.
|
private java.lang.String goal
private java.lang.String phase
private boolean aggregator
private java.lang.String requiresDependencyResolution
private boolean requiresProject
private boolean requiresReports
private boolean requiresOnline
private boolean inheritByDefault
private boolean requiresDirectInvocation
private LifecycleExecution execution
private java.util.List<Component> components
private java.util.List<Parameter> parameters
private java.lang.String description
private java.lang.String deprecation
private java.lang.String since
private java.lang.String call
public void addComponent(Component component)
component
- public void addParameter(Parameter parameter)
parameter
- public java.lang.String getCall()
public java.util.List<Component> getComponents()
public java.lang.String getDeprecation()
public java.lang.String getDescription()
public LifecycleExecution getExecution()
public java.lang.String getGoal()
public java.util.List<Parameter> getParameters()
public java.lang.String getPhase()
public java.lang.String getRequiresDependencyResolution()
public java.lang.String getSince()
public boolean isAggregator()
public boolean isInheritByDefault()
public boolean isRequiresDirectInvocation()
public boolean isRequiresOnline()
public boolean isRequiresProject()
public boolean isRequiresReports()
public void removeComponent(Component component)
component
- public void removeParameter(Parameter parameter)
parameter
- public void setAggregator(boolean aggregator)
aggregator
- public void setCall(java.lang.String call)
call
- public void setComponents(java.util.List<Component> components)
components
- public void setDeprecation(java.lang.String deprecation)
deprecation
- public void setDescription(java.lang.String description)
description
- public void setExecution(LifecycleExecution execution)
execution
- public void setGoal(java.lang.String goal)
goal
- public void setInheritByDefault(boolean inheritByDefault)
inheritByDefault
- public void setParameters(java.util.List<Parameter> parameters)
parameters
- public void setPhase(java.lang.String phase)
phase
- public void setRequiresDependencyResolution(java.lang.String requiresDependencyResolution)
requiresDependencyResolution
- public void setRequiresDirectInvocation(boolean requiresDirectInvocation)
requiresDirectInvocation
- public void setRequiresOnline(boolean requiresOnline)
requiresOnline
- public void setRequiresProject(boolean requiresProject)
requiresProject
- public void setRequiresReports(boolean requiresReports)
requiresReports
- public void setSince(java.lang.String since)
since
-