public class Mojo extends Object implements Serializable
Constructor and Description |
---|
Mojo() |
Modifier and Type | Method and Description |
---|---|
void |
addComponent(Component component)
Method addComponent.
|
void |
addParameter(Parameter parameter)
Method addParameter.
|
String |
getCall()
Get the target/method within the script to call when this
mojo executes.
|
List<Component> |
getComponents()
Method getComponents.
|
String |
getDeprecation()
Get a deprecation message for this mojo parameter.
|
String |
getDescription()
Get the description for this parameter.
|
LifecycleExecution |
getExecution()
Get information about a sub-execution of the Maven lifecycle
which should be processed.
|
String |
getGoal()
Get the name of the goal used to invoke this mojo.
|
List<Parameter> |
getParameters()
Method getParameters.
|
String |
getPhase()
Get the phase to which this mojo should be bound by default.
|
String |
getRequiresDependencyResolution()
Get the scope of dependencies that this mojo requires to
have resolved.
|
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(String call)
Set the target/method within the script to call when this
mojo executes.
|
void |
setComponents(List<Component> components)
Set list of plexus components required by this mojo.
|
void |
setDeprecation(String deprecation)
Set a deprecation message for this mojo parameter.
|
void |
setDescription(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(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(List<Parameter> parameters)
Set list of parameters used by this mojo.
|
void |
setPhase(String phase)
Set the phase to which this mojo should be bound by default.
|
void |
setRequiresDependencyResolution(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(String since)
Set version when the mojo was added to the API.
|
public void addComponent(Component component)
component
- a component object.public void addParameter(Parameter parameter)
parameter
- a parameter object.public String getCall()
public String getDeprecation()
public String getDescription()
public LifecycleExecution getExecution()
public String getGoal()
public String getPhase()
public String getRequiresDependencyResolution()
public 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
- a component object.public void removeParameter(Parameter parameter)
parameter
- a parameter object.public void setAggregator(boolean aggregator)
aggregator
- a aggregator object.public void setCall(String call)
call
- a call object.public void setComponents(List<Component> components)
components
- a components object.public void setDeprecation(String deprecation)
deprecation
- a deprecation object.public void setDescription(String description)
description
- a description object.public void setExecution(LifecycleExecution execution)
execution
- a execution object.public void setGoal(String goal)
goal
- a goal object.public void setInheritByDefault(boolean inheritByDefault)
inheritByDefault
- a inheritByDefault object.public void setParameters(List<Parameter> parameters)
parameters
- a parameters object.public void setPhase(String phase)
phase
- a phase object.public void setRequiresDependencyResolution(String requiresDependencyResolution)
requiresDependencyResolution
- a
requiresDependencyResolution object.public void setRequiresDirectInvocation(boolean requiresDirectInvocation)
requiresDirectInvocation
- a requiresDirectInvocation
object.public void setRequiresOnline(boolean requiresOnline)
requiresOnline
- a requiresOnline object.public void setRequiresProject(boolean requiresProject)
requiresProject
- a requiresProject object.public void setRequiresReports(boolean requiresReports)
requiresReports
- a requiresReports object.public void setSince(String since)
since
- a since object.Copyright © 2004–2024 The Apache Software Foundation. All rights reserved.