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
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 Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
By default, no need to aggregate the Maven project and its child modulesprivate static final String
private static final String
private String
Specify the required dependencies in a specified scopeprivate String
Specify the version when the Mojo was deprecated to the API.private boolean
By default, the Mojo could not be invoke directlyprivate String
Reference the invocation goal of the Mojoprivate String
Reference the invocation lifecycle of the Mojoprivate String
Reference the invocation phase of the Mojoprivate String
By default, the execution strategy is "once-per-session"private String
The goal name of the Mojoprivate boolean
By default, the Mojo is heritedstatic String
The Plexus component typeprivate org.codehaus.plexus.configuration.PlexusConfiguration
Plugin configurationstatic final String
"always" execution strategyprivate boolean
By default, the Mojo is onlineprivate Map
private List
private String
Reference the binded phase name of the Mojoprivate PluginDescriptor
Plugin descriptorprivate boolean
By default, the Mojo needs a Maven project to be executedprivate boolean
By default, the Mojo don't need reports to runprivate String
Specify the version when the Mojo was added to the API.static final String
"once-per-session" execution strategy -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addParameter
(Parameter parameter) boolean
private boolean
compareObjects
(Object first, Object second) boolean
getGoal()
getId()
org.codehaus.plexus.configuration.PlexusConfiguration
getPhase()
getRole()
getSince()
int
hashCode()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
void
setAggregator
(boolean aggregator) void
setDependencyResolutionRequired
(String requiresDependencyResolution) void
setDeprecated
(String deprecated) void
setDirectInvocationOnly
(boolean directInvocationOnly) void
setExecuteGoal
(String executeGoal) void
setExecuteLifecycle
(String executeLifecycle) void
setExecutePhase
(String executePhase) void
setExecutionStrategy
(String executionStrategy) void
void
setInheritedByDefault
(boolean inheritedByDefault) void
setLanguage
(String language) void
setMojoConfiguration
(org.codehaus.plexus.configuration.PlexusConfiguration mojoConfiguration) void
setOnlineRequired
(boolean requiresOnline) void
setParameters
(List parameters) void
void
setPluginDescriptor
(PluginDescriptor pluginDescriptor) void
setProjectRequired
(boolean requiresProject) void
setRequiresReports
(boolean requiresReports) void
Methods inherited from class org.codehaus.plexus.component.repository.ComponentDescriptor
addRequirement, addRequirement, addRequirements, getAlias, getComponentComposer, getComponentConfigurator, getComponentFactory, getComponentProfile, getComponentSetDescriptor, getConfiguration, getDescription, getHumanReadableKey, getImplementation, getImplementationClass, getInstantiationStrategy, getLifecycleHandler, getRealm, getRequirements, getRoleClass, getSource, getVersion, hasConfiguration, isIsolatedRealm, removeRequirement, removeRequirements, setAlias, setComponentComposer, setComponentConfigurator, setComponentFactory, setComponentProfile, setComponentSetDescriptor, setComponentType, setConfiguration, setDescription, setImplementation, setImplementationClass, setInstantiationStrategy, setIsolatedRealm, setLifecycleHandler, setRealm, setRole, setRoleClass, setRoleHint, setSource, setVersion, toString
-
Field Details
-
MAVEN_PLUGIN
The Plexus component type -
SINGLE_PASS_EXEC_STRATEGY
"once-per-session" execution strategy- See Also:
-
MULTI_PASS_EXEC_STRATEGY
"always" execution strategy- See Also:
-
DEFAULT_INSTANTIATION_STRATEGY
- See Also:
-
DEFAULT_LANGUAGE
- See Also:
-
parameters
-
parameterMap
-
executionStrategy
By default, the execution strategy is "once-per-session" -
goal
The goal name of the Mojo -
phase
Reference the binded phase name of the Mojo -
since
Specify the version when the Mojo was added to the API. Similar to Javadoc since. -
executePhase
Reference the invocation phase of the Mojo -
executeGoal
Reference the invocation goal of the Mojo -
executeLifecycle
Reference the invocation lifecycle of the Mojo -
deprecated
Specify the version when the Mojo was deprecated to the API. Similar to Javadoc deprecated. -
aggregator
private boolean aggregatorBy default, no need to aggregate the Maven project and its child modules -
dependencyResolutionRequired
Specify the required dependencies in a specified scope -
projectRequired
private boolean projectRequiredBy default, the Mojo needs a Maven project to be executed -
onlineRequired
private boolean onlineRequiredBy default, the Mojo is online -
mojoConfiguration
private org.codehaus.plexus.configuration.PlexusConfiguration mojoConfigurationPlugin configuration -
pluginDescriptor
Plugin descriptor -
inheritedByDefault
private boolean inheritedByDefaultBy default, the Mojo is herited -
directInvocationOnly
private boolean directInvocationOnlyBy default, the Mojo could not be invoke directly -
requiresReports
private boolean requiresReportsBy default, the Mojo don't need reports to run
-
-
Constructor Details
-
MojoDescriptor
public MojoDescriptor()Default constructor.
-
-
Method Details
-
getLanguage
- Returns:
- the language of this Mojo, i.e.
java
-
setLanguage
- Parameters:
language
- the new language
-
getDeprecated
- Returns:
true
if the Mojo is deprecated,false
otherwise.
-
setDeprecated
- Parameters:
deprecated
-true
to deprecate the Mojo,false
otherwise.
-
getParameters
- Returns:
- the list of parameters
-
setParameters
- Parameters:
parameters
- the new list of parameters- Throws:
DuplicateParameterException
- if any
-
addParameter
- Parameters:
parameter
- add a new parameter- Throws:
DuplicateParameterException
- if any
-
getParameterMap
- Returns:
- the list parameters as a Map
-
setDependencyResolutionRequired
- Parameters:
requiresDependencyResolution
- the new required dependencies in a specified scope
-
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
- Returns:
- the binded phase name of the Mojo
-
setPhase
- Parameters:
phase
- the new binded phase name of the Mojo
-
getSince
- Returns:
- the version when the Mojo was added to the API
-
setSince
- Parameters:
since
- the new version when the Mojo was added to the API
-
getGoal
- Returns:
- The goal name of the Mojo
-
setGoal
- Parameters:
goal
- The new goal name of the Mojo
-
getExecutePhase
- Returns:
- the invocation phase of the Mojo
-
setExecutePhase
- Parameters:
executePhase
- the new invocation phase of the Mojo
-
alwaysExecute
public boolean alwaysExecute()- Returns:
true
if the Mojo usesalways
for theexecutionStrategy
-
getExecutionStrategy
- Returns:
- the execution strategy
-
setExecutionStrategy
- 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
- Overrides:
getRole
in classorg.codehaus.plexus.component.repository.ComponentDescriptor
-
getRoleHint
- Overrides:
getRoleHint
in classorg.codehaus.plexus.component.repository.ComponentDescriptor
-
getId
- Returns:
- the id of the mojo, based on the goal name
-
getFullGoalName
- Returns:
- the full goal name
- See Also:
-
getComponentType
- Overrides:
getComponentType
in classorg.codehaus.plexus.component.repository.ComponentDescriptor
-
getPluginDescriptor
- Returns:
- the plugin descriptor
-
setPluginDescriptor
- 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
- Overrides:
equals
in classorg.codehaus.plexus.component.repository.ComponentDescriptor
-
compareObjects
-
hashCode
public int hashCode()- Overrides:
hashCode
in classorg.codehaus.plexus.component.repository.ComponentDescriptor
-
getExecuteLifecycle
- Returns:
- the invocation lifecycle of the Mojo
-
setExecuteLifecycle
- 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
- Parameters:
executeGoal
- the new invocation goal of the Mojo
-
getExecuteGoal
- Returns:
- the invocation goal of the Mojo
-