Package org.apache.maven.plugin.descriptor

Class MojoDescriptor

java.lang.Object
org.codehaus.plexus.component.repository.ComponentDescriptor
org.apache.maven.plugin.descriptor.MojoDescriptor
All Implemented Interfaces:
Cloneable
public class MojoDescriptor extends org.codehaus.plexus.component.repository.ComponentDescriptor implements Cloneable
The bean containing the Mojo descriptor.
For more information about the usage tag, have a look to: http://maven.apache.org/developers/mojo-api-specification.html
Version:
$Id: MojoDescriptor.java 743587 2009-02-12 01:32:50Z jdcasey $

  • Field Details

    • MAVEN_PLUGIN

      public static String MAVEN_PLUGIN
      The Plexus component type

    • SINGLE_PASS_EXEC_STRATEGY

      public static final String SINGLE_PASS_EXEC_STRATEGY
      "once-per-session" execution strategy
      See Also:

    • MULTI_PASS_EXEC_STRATEGY

      public static final String MULTI_PASS_EXEC_STRATEGY
      "always" execution strategy
      See Also:

    • DEFAULT_INSTANTIATION_STRATEGY

      private static final String DEFAULT_INSTANTIATION_STRATEGY
      See Also:

    • DEFAULT_LANGUAGE

      private static final String DEFAULT_LANGUAGE
      See Also:

    • parameters

      private List parameters

    • parameterMap

      private Map parameterMap

    • executionStrategy

      private String executionStrategy
      By default, the execution strategy is "once-per-session"

    • goal

      private String goal
      The goal name of the Mojo

    • phase

      private String phase
      Reference the binded phase name of the Mojo

    • since

      private String since
      Specify the version when the Mojo was added to the API. Similar to Javadoc since.

    • executePhase

      private String executePhase
      Reference the invocation phase of the Mojo

    • executeGoal

      private String executeGoal
      Reference the invocation goal of the Mojo

    • executeLifecycle

      private String executeLifecycle
      Reference the invocation lifecycle of the Mojo

    • deprecated

      private String deprecated
      Specify the version when the Mojo was deprecated to the API. Similar to Javadoc deprecated.

    • aggregator

      private boolean aggregator
      By default, no need to aggregate the Maven project and its child modules

    • dependencyResolutionRequired

      private String dependencyResolutionRequired
      Specify the required dependencies in a specified scope

    • projectRequired

      private boolean projectRequired
      By default, the Mojo needs a Maven project to be executed

    • onlineRequired

      private boolean onlineRequired
      By default, the Mojo is online

    • mojoConfiguration

      private org.codehaus.plexus.configuration.PlexusConfiguration mojoConfiguration
      Plugin configuration

    • pluginDescriptor

      private PluginDescriptor pluginDescriptor
      Plugin descriptor

    • inheritedByDefault

      private boolean inheritedByDefault
      By default, the Mojo is herited

    • directInvocationOnly

      private boolean directInvocationOnly
      By default, the Mojo could not be invoke directly

    • requiresReports

      private boolean requiresReports
      By default, the Mojo don't need reports to run

  • Constructor Details

    • MojoDescriptor

      public MojoDescriptor()
      Default constructor.

  • Method Details

    • getLanguage

      public String getLanguage()
      Returns:
      the language of this Mojo, i.e. java

    • setLanguage

      public void setLanguage(String language)
      Parameters:
      language - the new language

    • getDeprecated

      public String getDeprecated()
      Returns:
      true if the Mojo is deprecated, false otherwise.

    • setDeprecated

      public void setDeprecated(String deprecated)
      Parameters:
      deprecated - true to deprecate the Mojo, false otherwise.

    • getParameters

      public List getParameters()
      Returns:
      the list of parameters

    • setParameters

      public void setParameters(List parameters) throws DuplicateParameterException
      Parameters:
      parameters - the new list of parameters
      Throws:
      DuplicateParameterException - if any

    • addParameter

      public void addParameter(Parameter parameter) throws DuplicateParameterException
      Parameters:
      parameter - add a new parameter
      Throws:
      DuplicateParameterException - if any

    • getParameterMap

      public Map getParameterMap()
      Returns:
      the list parameters as a Map

    • setDependencyResolutionRequired

      public void setDependencyResolutionRequired(String requiresDependencyResolution)
      Parameters:
      requiresDependencyResolution - the new required dependencies in a specified scope

    • isDependencyResolutionRequired

      public String isDependencyResolutionRequired()
      Returns:
      the required dependencies in a specified scope

    • setProjectRequired

      public void setProjectRequired(boolean requiresProject)
      Parameters:
      requiresProject - true if the Mojo needs a Maven project to be executed, false otherwise.

    • isProjectRequired

      public boolean isProjectRequired()
      Returns:
      true if the Mojo needs a Maven project to be executed, false otherwise.

    • setOnlineRequired

      public void setOnlineRequired(boolean requiresOnline)
      Parameters:
      requiresOnline - true if the Mojo is online, false otherwise.

    • isOnlineRequired

      public boolean isOnlineRequired()
      Returns:
      true if the Mojo is online, false otherwise.

    • requiresOnline

      public boolean requiresOnline()
      Returns:
      true if the Mojo is online, false otherwise.

    • getPhase

      public String getPhase()
      Returns:
      the binded phase name of the Mojo

    • setPhase

      public void setPhase(String phase)
      Parameters:
      phase - the new binded phase name of the Mojo

    • getSince

      public String getSince()
      Returns:
      the version when the Mojo was added to the API

    • setSince

      public void setSince(String since)
      Parameters:
      since - the new version when the Mojo was added to the API

    • getGoal

      public String getGoal()
      Returns:
      The goal name of the Mojo

    • setGoal

      public void setGoal(String goal)
      Parameters:
      goal - The new goal name of the Mojo

    • getExecutePhase

      public String getExecutePhase()
      Returns:
      the invocation phase of the Mojo

    • setExecutePhase

      public void setExecutePhase(String executePhase)
      Parameters:
      executePhase - the new invocation phase of the Mojo

    • alwaysExecute

      public boolean alwaysExecute()
      Returns:
      true if the Mojo uses always for the executionStrategy

    • getExecutionStrategy

      public String getExecutionStrategy()
      Returns:
      the execution strategy

    • setExecutionStrategy

      public void setExecutionStrategy(String executionStrategy)
      Parameters:
      executionStrategy - the new execution strategy

    • getMojoConfiguration

      public org.codehaus.plexus.configuration.PlexusConfiguration getMojoConfiguration()
      Returns:
      the mojo configuration

    • setMojoConfiguration

      public void setMojoConfiguration(org.codehaus.plexus.configuration.PlexusConfiguration mojoConfiguration)
      Parameters:
      mojoConfiguration - a new mojo configuration

    • getRole

      public String getRole()
      Overrides:
      getRole in class org.codehaus.plexus.component.repository.ComponentDescriptor

    • getRoleHint

      public String getRoleHint()
      Overrides:
      getRoleHint in class org.codehaus.plexus.component.repository.ComponentDescriptor

    • getId

      public String getId()
      Returns:
      the id of the mojo, based on the goal name

    • getFullGoalName

      public String getFullGoalName()
      Returns:
      the full goal name
      See Also:

    • getComponentType

      public String getComponentType()
      Overrides:
      getComponentType in class org.codehaus.plexus.component.repository.ComponentDescriptor

    • getPluginDescriptor

      public PluginDescriptor getPluginDescriptor()
      Returns:
      the plugin descriptor

    • setPluginDescriptor

      public void setPluginDescriptor(PluginDescriptor pluginDescriptor)
      Parameters:
      pluginDescriptor - the new plugin descriptor

    • isInheritedByDefault

      public boolean isInheritedByDefault()
      Returns:
      true if the Mojo is herited, false otherwise.

    • setInheritedByDefault

      public void setInheritedByDefault(boolean inheritedByDefault)
      Parameters:
      inheritedByDefault - true if the Mojo is herited, false otherwise.

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class org.codehaus.plexus.component.repository.ComponentDescriptor

    • compareObjects

      private boolean compareObjects(Object first, Object second)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class org.codehaus.plexus.component.repository.ComponentDescriptor

    • getExecuteLifecycle

      public String getExecuteLifecycle()
      Returns:
      the invocation lifecycle of the Mojo

    • setExecuteLifecycle

      public void setExecuteLifecycle(String executeLifecycle)
      Parameters:
      executeLifecycle - the new invocation lifecycle of the Mojo

    • setAggregator

      public void setAggregator(boolean aggregator)
      Parameters:
      aggregator - true if the Mojo uses the Maven project and its child modules, false otherwise.

    • isAggregator

      public boolean isAggregator()
      Returns:
      true if the Mojo uses the Maven project and its child modules, false otherwise.

    • isDirectInvocationOnly

      public boolean isDirectInvocationOnly()
      Returns:
      true if the Mojo could not be invoke directly, false otherwise.

    • setDirectInvocationOnly

      public void setDirectInvocationOnly(boolean directInvocationOnly)
      Parameters:
      directInvocationOnly - true if the Mojo could not be invoke directly, false otherwise.

    • isRequiresReports

      public boolean isRequiresReports()
      Returns:
      true if the Mojo needs reports to run, false otherwise.

    • setRequiresReports

      public void setRequiresReports(boolean requiresReports)
      Parameters:
      requiresReports - true if the Mojo needs reports to run, false otherwise.

    • setExecuteGoal

      public void setExecuteGoal(String executeGoal)
      Parameters:
      executeGoal - the new invocation goal of the Mojo

    • getExecuteGoal

      public String getExecuteGoal()
      Returns:
      the invocation goal of the Mojo