org.apache.maven.plugin.tools.model
Class Mojo

java.lang.Object
  extended by org.apache.maven.plugin.tools.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
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

goal

private java.lang.String goal
Field goal


phase

private java.lang.String phase
Field phase


aggregator

private boolean aggregator
Field aggregator


requiresDependencyResolution

private java.lang.String requiresDependencyResolution
Field requiresDependencyResolution


requiresProject

private boolean requiresProject
Field requiresProject


requiresReports

private boolean requiresReports
Field requiresReports


requiresOnline

private boolean requiresOnline
Field requiresOnline


inheritByDefault

private boolean inheritByDefault
Field inheritByDefault


requiresDirectInvocation

private boolean requiresDirectInvocation
Field requiresDirectInvocation


execution

private LifecycleExecution execution
Field execution


components

private java.util.List components
Field components


parameters

private java.util.List parameters
Field parameters


description

private java.lang.String description
Field description


deprecation

private java.lang.String deprecation
Field deprecation


call

private java.lang.String call
Field call


modelEncoding

private java.lang.String modelEncoding
Constructor Detail

Mojo

public Mojo()
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.


getComponents

public java.util.List getComponents()
Method getComponents


getDeprecation

public java.lang.String getDeprecation()
Get A deprecation message for this mojo parameter.


getDescription

public java.lang.String getDescription()
Get The description for this parameter.


getExecution

public LifecycleExecution getExecution()
Get Information about a sub-execution of the Maven lifecycle which should be processed.


getGoal

public java.lang.String getGoal()
Get The name of the goal used to invoke this mojo.


getParameters

public java.util.List getParameters()
Method getParameters


getPhase

public java.lang.String getPhase()
Get The phase to which this mojo should be bound by default.


getRequiresDependencyResolution

public java.lang.String getRequiresDependencyResolution()
Get The scope of dependencies that this mojo requires to have resolved.


isAggregator

public boolean isAggregator()
Get Whether this mojo operates as an aggregator when the reactor is run. That is, only runs once.


isInheritByDefault

public boolean isInheritByDefault()
Get Whether this mojo's configuration should propagate down the POM inheritance chain by default.


isRequiresDirectInvocation

public boolean isRequiresDirectInvocation()
Get If true, this mojo can only be directly invoked (eg. specified directly on the command line).


isRequiresOnline

public boolean isRequiresOnline()
Get Whether this mojo requires online mode to operate normally.


isRequiresProject

public boolean isRequiresProject()
Get Whether this mojo requires a project instance in order to execute.


isRequiresReports

public boolean isRequiresReports()
Get Whether this mojo requires a reports section in the POM.


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 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 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 -

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

getModelEncoding

public java.lang.String getModelEncoding()