|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.tools.model.Mojo
public class Mojo
Mojo descriptor definition.
Field Summary | |
---|---|
private boolean |
aggregator
Field aggregator |
private java.lang.String |
call
Field call |
private java.util.List |
components
Field components |
private java.lang.String |
deprecation
Field deprecation |
private java.lang.String |
description
Field description |
private LifecycleExecution |
execution
Field execution |
private java.lang.String |
goal
Field goal |
private boolean |
inheritByDefault
Field inheritByDefault |
private java.lang.String |
modelEncoding
|
private java.util.List |
parameters
Field parameters |
private java.lang.String |
phase
Field phase |
private java.lang.String |
requiresDependencyResolution
Field requiresDependencyResolution |
private boolean |
requiresDirectInvocation
Field requiresDirectInvocation |
private boolean |
requiresOnline
Field requiresOnline |
private boolean |
requiresProject
Field requiresProject |
private boolean |
requiresReports
Field requiresReports |
Constructor Summary | |
---|---|
Mojo()
|
Method Summary | |
---|---|
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 |
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.lang.String |
getModelEncoding()
|
java.util.List |
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. |
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 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 |
setModelEncoding(java.lang.String modelEncoding)
|
void |
setParameters(java.util.List 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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
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 components
private java.util.List parameters
private java.lang.String description
private java.lang.String deprecation
private java.lang.String call
private java.lang.String modelEncoding
Constructor Detail |
---|
public Mojo()
Method Detail |
---|
public void addComponent(Component component)
component
- public void addParameter(Parameter parameter)
parameter
- public java.lang.String getCall()
public java.util.List getComponents()
public java.lang.String getDeprecation()
public java.lang.String getDescription()
public LifecycleExecution getExecution()
public java.lang.String getGoal()
public java.util.List getParameters()
public java.lang.String getPhase()
public java.lang.String getRequiresDependencyResolution()
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 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 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 setModelEncoding(java.lang.String modelEncoding)
public java.lang.String getModelEncoding()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |