public class MojoDescriptor extends Object implements Serializable
Constructor and Description |
---|
MojoDescriptor() |
Modifier and Type | Method and Description |
---|---|
void |
addConfiguration(Configuration configuration)
Method addConfiguration.
|
void |
addParameter(Parameter parameter)
Method addParameter.
|
void |
addRequirement(Requirement requirement)
Method addRequirement.
|
String |
getComposer()
Get the composer field.
|
List<Configuration> |
getConfiguration()
Method getConfiguration.
|
String |
getConfigurator()
Get the configurator type to use when injecting parameter
values into this Mojo.
|
String |
getDeprecated()
Get specify the version when the Mojo was deprecated to the
API.
|
String |
getDescription()
Get the description of this Mojo's functionality.
|
String |
getExecuteGoal()
Get reference the invocation goal of the Mojo.
|
String |
getExecuteLifecycle()
Get the executeLifecycle field.
|
String |
getExecutePhase()
Get reference the invocation phase of the Mojo.
|
String |
getExecutionStrategy()
Get specify the execution strategy:
once-per-session , always . |
String |
getGoal()
Get the goal name for the Mojo, that users will reference
from the command line to execute the Mojo directly,
or inside a POM in order to provide
Mojo-specific configuration.
|
String |
getImplementation()
Get the Mojo's fully-qualified class name (or script path in
the case of non-Java Mojos).
|
String |
getInstantiationStrategy()
Get specify the instantiation strategy.
|
String |
getLanguage()
Get the implementation language for this Mojo (java,
beanshell, etc.).
|
List<Parameter> |
getParameters()
Method getParameters.
|
String |
getPhase()
Get defines a default phase to bind a mojo execution to if
the user does not explicitly set a phase in the POM.
|
List<Requirement> |
getRequirements()
Method getRequirements.
|
String |
getRequiresDependencyCollection()
Get flags this mojo as requiring information about the
dependencies that would make up the specified class
path.
|
String |
getRequiresDependencyResolution()
Get flags this Mojo as requiring the dependencies in the
specified class path to be resolved before it can
execute:
compile ,
runtime , test ,
compile+runtime (since Maven 3.0)
or runtime+system (since Maven 3.0). |
String |
getSince()
Get specify the version when the Mojo was added to the API.
|
boolean |
isAggregator()
Get flags this Mojo to run it in a multi module way, i.e.
|
boolean |
isInheritedByDefault()
Get specify that the Mojo is inherited.
|
boolean |
isRequiresDirectInvocation()
Get flags this Mojo to be invoked directly only.
|
boolean |
isRequiresOnline()
Get flags this Mojo to require online mode for its
operation.
|
boolean |
isRequiresProject()
Get flags this Mojo to require running inside of a project.
|
boolean |
isRequiresReports()
Get flags this Mojo to require running inside of a reports
context.
|
boolean |
isThreadSafe()
Get marks this mojo as being thread-safe, i.e.
|
void |
removeConfiguration(Configuration configuration)
Method removeConfiguration.
|
void |
removeParameter(Parameter parameter)
Method removeParameter.
|
void |
removeRequirement(Requirement requirement)
Method removeRequirement.
|
void |
setAggregator(boolean aggregator)
Set flags this Mojo to run it in a multi module way, i.e.
|
void |
setComposer(String composer)
Set the composer field.
|
void |
setConfiguration(List<Configuration> configuration)
Set the configuration field.
|
void |
setConfigurator(String configurator)
Set the configurator type to use when injecting parameter
values into this Mojo.
|
void |
setDeprecated(String deprecated)
Set specify the version when the Mojo was deprecated to the
API.
|
void |
setDescription(String description)
Set the description of this Mojo's functionality.
|
void |
setExecuteGoal(String executeGoal)
Set reference the invocation goal of the Mojo.
|
void |
setExecuteLifecycle(String executeLifecycle)
Set the executeLifecycle field.
|
void |
setExecutePhase(String executePhase)
Set reference the invocation phase of the Mojo.
|
void |
setExecutionStrategy(String executionStrategy)
Set specify the execution strategy:
once-per-session , always . |
void |
setGoal(String goal)
Set the goal name for the Mojo, that users will reference
from the command line to execute the Mojo directly,
or inside a POM in order to provide
Mojo-specific configuration.
|
void |
setImplementation(String implementation)
Set the Mojo's fully-qualified class name (or script path in
the case of non-Java Mojos).
|
void |
setInheritedByDefault(boolean inheritedByDefault)
Set specify that the Mojo is inherited.
|
void |
setInstantiationStrategy(String instantiationStrategy)
Set specify the instantiation strategy.
|
void |
setLanguage(String language)
Set the implementation language for this Mojo (java,
beanshell, etc.).
|
void |
setParameters(List<Parameter> parameters)
Set the parameters field.
|
void |
setPhase(String phase)
Set defines a default phase to bind a mojo execution to if
the user does not explicitly set a phase in the POM.
|
void |
setRequirements(List<Requirement> requirements)
Set the requirements field.
|
void |
setRequiresDependencyCollection(String requiresDependencyCollection)
Set flags this mojo as requiring information about the
dependencies that would make up the specified class
path.
|
void |
setRequiresDependencyResolution(String requiresDependencyResolution)
Set flags this Mojo as requiring the dependencies in the
specified class path to be resolved before it can
execute:
compile ,
runtime , test ,
compile+runtime (since Maven 3.0)
or runtime+system (since Maven 3.0). |
void |
setRequiresDirectInvocation(boolean requiresDirectInvocation)
Set flags this Mojo to be invoked directly only.
|
void |
setRequiresOnline(boolean requiresOnline)
Set flags this Mojo to require online mode for its
operation.
|
void |
setRequiresProject(boolean requiresProject)
Set flags this Mojo to require running inside of a project.
|
void |
setRequiresReports(boolean requiresReports)
Set flags this Mojo to require running inside of a reports
context.
|
void |
setSince(String since)
Set specify the version when the Mojo was added to the API.
|
void |
setThreadSafe(boolean threadSafe)
Set marks this mojo as being thread-safe, i.e.
|
public MojoDescriptor()
public void addConfiguration(Configuration configuration)
configuration
- public void addParameter(Parameter parameter)
parameter
- public void addRequirement(Requirement requirement)
requirement
- public String getComposer()
public List<Configuration> getConfiguration()
public String getConfigurator()
public String getDeprecated()
public String getDescription()
public String getExecuteGoal()
public String getExecuteLifecycle()
public String getExecutePhase()
public String getExecutionStrategy()
once-per-session
, always
.public String getGoal()
public String getImplementation()
public String getInstantiationStrategy()
public String getLanguage()
public List<Parameter> getParameters()
public String getPhase()
<phase>
element from the
surrounding <execution>
element.public List<Requirement> getRequirements()
public String getRequiresDependencyCollection()
public String getRequiresDependencyResolution()
compile
,
runtime
, test
,
compile+runtime
(since Maven 3.0)
or runtime+system
(since Maven 3.0).public String getSince()
public boolean isAggregator()
public boolean isInheritedByDefault()
public boolean isRequiresDirectInvocation()
public boolean isRequiresOnline()
public boolean isRequiresProject()
public boolean isRequiresReports()
public boolean isThreadSafe()
public void removeConfiguration(Configuration configuration)
configuration
- public void removeParameter(Parameter parameter)
parameter
- public void removeRequirement(Requirement requirement)
requirement
- public void setAggregator(boolean aggregator)
aggregator
- public void setComposer(String composer)
composer
- public void setConfiguration(List<Configuration> configuration)
configuration
- public void setConfigurator(String configurator)
configurator
- public void setDeprecated(String deprecated)
deprecated
- public void setDescription(String description)
description
- public void setExecuteGoal(String executeGoal)
executeGoal
- public void setExecuteLifecycle(String executeLifecycle)
executeLifecycle
- public void setExecutePhase(String executePhase)
executePhase
- public void setExecutionStrategy(String executionStrategy)
once-per-session
, always
.executionStrategy
- public void setGoal(String goal)
goal
- public void setImplementation(String implementation)
implementation
- public void setInheritedByDefault(boolean inheritedByDefault)
inheritedByDefault
- public void setInstantiationStrategy(String instantiationStrategy)
instantiationStrategy
- public void setLanguage(String language)
language
- public void setParameters(List<Parameter> parameters)
parameters
- public void setPhase(String phase)
<phase>
element from the
surrounding <execution>
element.phase
- public void setRequirements(List<Requirement> requirements)
requirements
- public void setRequiresDependencyCollection(String requiresDependencyCollection)
requiresDependencyCollection
- public void setRequiresDependencyResolution(String requiresDependencyResolution)
compile
,
runtime
, test
,
compile+runtime
(since Maven 3.0)
or runtime+system
(since Maven 3.0).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 setSince(String since)
since
- public void setThreadSafe(boolean threadSafe)
threadSafe
- Copyright © 2001–2014 The Apache Software Foundation. All rights reserved.