org.apache.maven.tools.plugin.extractor.java
Interface JavaMojoAnnotation

All Known Implementing Classes:
JavaMojoDescriptorExtractor

public interface JavaMojoAnnotation

List all Javadoc annotations used to describe a Mojo.

Since:
2.4
Version:
$Id: JavaMojoAnnotation.java 938263 2010-04-26 22:48:25Z bentmann $
Author:
Vincent Siveton

Field Summary
static java.lang.String AGGREGATOR
          Flags this Mojo to run it in a multi module way, i.e.
static java.lang.String COMPONENT
          Populates the field with an instance of a Plexus component.
static java.lang.String COMPONENT_ROLE
          Refer to @component role="...".
static java.lang.String COMPONENT_ROLEHINT
          Refer to @component roleHint="...".
static java.lang.String CONFIGURATOR
          The configurator type to use when injecting parameter values into this Mojo.
static java.lang.String DEPRECATED
          Refer to @deprecated <since-text>
Note: Could be defined in a Mojo Type or a Mojo Field.
static java.lang.String DESCRIPTION
          The description for the Mojo.
static java.lang.String EXECUTE
          Refer to @execute ....
static java.lang.String EXECUTE_GOAL
          The Mojo goal will be executed in isolation.
static java.lang.String EXECUTE_LIFECYCLE
          The Mojo will be invoke in a parallel lifecycle.
static java.lang.String EXECUTE_PHASE
          The Mojo will be invoke in a parallel lifecycle, ending at the given phase.
static java.lang.String EXECUTION_STATEGY
          Refer to @executionStrategy <strategy>.
static java.lang.String GOAL
          The name for the Mojo that users will reference to execute it.
static java.lang.String IMPLEMENTATION
          The Mojo's fully-qualified class name.
static java.lang.String INHERIT_BY_DEFAULT
          Allow Mojo inheritance.
static java.lang.String INSTANTIATION_STRATEGY
          Refer to @instantiationStrategy <per-lookup>.
static java.lang.String LANGUAGE
          The implementation language for the Mojo.
static java.lang.String MULTI_EXECUTION_STRATEGY
          Specifies the execution strategy
Refer to @attainAlways.
static java.lang.String PARAMETER
          Refer to @parameter ...
Note: Should be defined in a Mojo Field.
static java.lang.String PARAMETER_ALIAS
          This defines an alias which can be used to configure a parameter.
static java.lang.String PARAMETER_DEFAULT_VALUE
          This defines the default value to be injected into this parameter of the Mojo at buildtime.
static java.lang.String PARAMETER_EXPRESSION
          This defines the expression used to calculate the value to be injected into this parameter of the Mojo at buildtime.
static java.lang.String PARAMETER_IMPLEMENTATION
          This defines the default implementation in the case the parameter type is an interface.
static java.lang.String PARAMETER_PROPERTY
          This indicates the base name of the bean properties used to read/write this parameter's value.
static java.lang.String PHASE
          Refer to @phase <phaseName>.
static java.lang.String READONLY
          Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified configuration).
static java.lang.String REQUIRED
          Whether this parameter is required for the Mojo to function
Refer to @required.
static java.lang.String REQUIRES_DEPENDENCY_COLLECTION
          Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be collected before it can execute.
static java.lang.String REQUIRES_DEPENDENCY_RESOLUTION
          Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be resolved before it can execute.
static java.lang.String REQUIRES_DIRECT_INVOCATION
          Refer to @requiresDirectInvocation <true|false>.
static java.lang.String REQUIRES_ONLINE
          Flags this Mojo to run online.
static java.lang.String REQUIRES_PROJECT
          Flags this Mojo to run inside of a project.
static java.lang.String REQUIRES_REPORTS
          Flags this Mojo to run inside reports.
static java.lang.String SINCE
          Refer to @since <deprecated-text>
Note: Could be defined in a Mojo Type or a Mojo Field.
static java.lang.String THREAD_SAFE
          Indicates that this mojo is thread-safe and can be run in parallel Note: Should be defined in a Mojo Type.
 

Field Detail

AGGREGATOR

static final java.lang.String AGGREGATOR
Flags this Mojo to run it in a multi module way, i.e. aggregate the build with the set of projects listed as modules.
Refer to @aggregator.
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

CONFIGURATOR

static final java.lang.String CONFIGURATOR
The configurator type to use when injecting parameter values into this Mojo. The value is normally deduced from the Mojo's implementation language, but can be specified to allow a custom ComponentConfigurator implementation to be used.
Refer to @configurator <roleHint>.
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

DESCRIPTION

static final java.lang.String DESCRIPTION
The description for the Mojo.
Refer to @description.
Note: Should be defined in a Mojo Type.
Note: Mojo's description is auto-detect.

See Also:
Constant Field Values

EXECUTE

static final java.lang.String EXECUTE
Refer to @execute ....
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

EXECUTE_GOAL

static final java.lang.String EXECUTE_GOAL
The Mojo goal will be executed in isolation.
Refer to @execute goal="<goalName>".
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

EXECUTE_LIFECYCLE

static final java.lang.String EXECUTE_LIFECYCLE
The Mojo will be invoke in a parallel lifecycle.
Refer to @execute lifecycle="<lifecycleId>".
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

EXECUTE_PHASE

static final java.lang.String EXECUTE_PHASE
The Mojo will be invoke in a parallel lifecycle, ending at the given phase.
Refer to @execute phase="<phaseName>".
Refer to @execute lifecycle="<lifecycleId>" phase="<phaseName>".
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

EXECUTION_STATEGY

static final java.lang.String EXECUTION_STATEGY
Refer to @executionStrategy <strategy>.
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

GOAL

static final java.lang.String GOAL
The name for the Mojo that users will reference to execute it.
Refer to @goal <goalName>.
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

IMPLEMENTATION

static final java.lang.String IMPLEMENTATION
The Mojo's fully-qualified class name.
Refer to @implementation.
Note: Should be defined in a Mojo Type.
Note: Mojo's implementation is auto-detect.

See Also:
Constant Field Values

INHERIT_BY_DEFAULT

static final java.lang.String INHERIT_BY_DEFAULT
Allow Mojo inheritance.
Refer to @inheritByDefault <true|false>.
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

INSTANTIATION_STRATEGY

static final java.lang.String INSTANTIATION_STRATEGY
Refer to @instantiationStrategy <per-lookup>.
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

LANGUAGE

static final java.lang.String LANGUAGE
The implementation language for the Mojo.
Refer to @language.
Note: Should be defined in a Mojo Type.
Note: Mojo's implementation is auto-detect.

See Also:
Constant Field Values

MULTI_EXECUTION_STRATEGY

static final java.lang.String MULTI_EXECUTION_STRATEGY
Specifies the execution strategy
Refer to @attainAlways.
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

PHASE

static final java.lang.String PHASE
Refer to @phase <phaseName>.
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

REQUIRES_DEPENDENCY_RESOLUTION

static final java.lang.String REQUIRES_DEPENDENCY_RESOLUTION
Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be resolved before it can execute. Currently supports compile, runtime, and test scopes.
Refer to @requiresDependencyResolution <requiredScope>.
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

REQUIRES_DEPENDENCY_COLLECTION

static final java.lang.String REQUIRES_DEPENDENCY_COLLECTION
Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be collected before it can execute. Currently supports compile, runtime, and test scopes.
Refer to @requiresDependencyCollection <requiredScope>.
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

REQUIRES_DIRECT_INVOCATION

static final java.lang.String REQUIRES_DIRECT_INVOCATION
Refer to @requiresDirectInvocation <true|false>.
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

REQUIRES_ONLINE

static final java.lang.String REQUIRES_ONLINE
Flags this Mojo to run online.
Refer to @requiresOnline <true|false>.
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

REQUIRES_PROJECT

static final java.lang.String REQUIRES_PROJECT
Flags this Mojo to run inside of a project.
Refer to @requiresProject <true|false>.
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

REQUIRES_REPORTS

static final java.lang.String REQUIRES_REPORTS
Flags this Mojo to run inside reports.
Refer to @requiresReports <true|false>.
Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values

COMPONENT

static final java.lang.String COMPONENT
Populates the field with an instance of a Plexus component. This is like declaring a requirement in a Plexus component.
Refer to @component ....
Note: Should be defined in a Mojo Field.

See Also:
Constant Field Values

COMPONENT_ROLE

static final java.lang.String COMPONENT_ROLE
Refer to @component role="...".
Note: Should be defined in a Mojo Field.

See Also:
Constant Field Values

COMPONENT_ROLEHINT

static final java.lang.String COMPONENT_ROLEHINT
Refer to @component roleHint="...".
Note: Should be defined in a Mojo Field.

See Also:
Constant Field Values

PARAMETER

static final java.lang.String PARAMETER
Refer to @parameter ...
Note: Should be defined in a Mojo Field.

See Also:
Constant Field Values

PARAMETER_ALIAS

static final java.lang.String PARAMETER_ALIAS
This defines an alias which can be used to configure a parameter. This is primarily useful to improve user-friendliness.
Refer to @parameter alias="...".
Note: Should be defined in a Mojo Field.

See Also:
Constant Field Values

PARAMETER_DEFAULT_VALUE

static final java.lang.String PARAMETER_DEFAULT_VALUE
This defines the default value to be injected into this parameter of the Mojo at buildtime.
Refer to @parameter default-value="...".
Note: Should be defined in a Mojo Field.

See Also:
Constant Field Values

PARAMETER_EXPRESSION

static final java.lang.String PARAMETER_EXPRESSION
This defines the expression used to calculate the value to be injected into this parameter of the Mojo at buildtime.
Refer to @parameter expression="...".
Note: Should be defined in a Mojo Field.

See Also:
Constant Field Values

PARAMETER_IMPLEMENTATION

static final java.lang.String PARAMETER_IMPLEMENTATION
This defines the default implementation in the case the parameter type is an interface.
Refer to @parameter implementation="...".
Note: Should be defined in a Mojo Field.

See Also:
Constant Field Values

PARAMETER_PROPERTY

static final java.lang.String PARAMETER_PROPERTY
This indicates the base name of the bean properties used to read/write this parameter's value.
Refer to @parameter property="project"

Would say there is a getProject() method and a setProject(Project) method. Here the field name would not be the basis for the parameter's name. This mode of operation will allow the mojos to be usable as beans and will be the promoted form of use.
Note: Should be defined in a Mojo Field.

See Also:
Constant Field Values

READONLY

static final java.lang.String READONLY
Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified configuration).
Refer to @readonly.
Note: Should be defined in a Mojo Field.

See Also:
Constant Field Values

REQUIRED

static final java.lang.String REQUIRED
Whether this parameter is required for the Mojo to function
Refer to @required.
Note: Should be defined in a Mojo Field.

See Also:
Constant Field Values

SINCE

static final java.lang.String SINCE
Refer to @since <deprecated-text>
Note: Could be defined in a Mojo Type or a Mojo Field.

See Also:
Constant Field Values

DEPRECATED

static final java.lang.String DEPRECATED
Refer to @deprecated <since-text>
Note: Could be defined in a Mojo Type or a Mojo Field.

See Also:
Constant Field Values

THREAD_SAFE

static final java.lang.String THREAD_SAFE
Indicates that this mojo is thread-safe and can be run in parallel Note: Should be defined in a Mojo Type.

See Also:
Constant Field Values


Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.