|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JavaMojoAnnotation
List all Javadoc annotations used to describe a Mojo.
Field Summary | |
---|---|
static String |
AGGREGATOR
Flags this Mojo to run it in a multi module way, i.e. |
static String |
COMPONENT
Populates the field with an instance of a Plexus component. |
static String |
COMPONENT_ROLE
Refer to @component role="..." . |
static String |
COMPONENT_ROLEHINT
Refer to @component roleHint="..." . |
static String |
CONFIGURATOR
The configurator type to use when injecting parameter values into this Mojo. |
static String |
DEPRECATED
Refer to @deprecated <since-text>
Note: Could be defined in a Mojo Type or a Mojo Field. |
static String |
DESCRIPTION
The description for the Mojo. |
static String |
EXECUTE
Refer to @execute ... . |
static String |
EXECUTE_GOAL
The Mojo goal will be executed in isolation. |
static String |
EXECUTE_LIFECYCLE
The Mojo will be invoke in a parallel lifecycle. |
static String |
EXECUTE_PHASE
The Mojo will be invoke in a parallel lifecycle, ending at the given phase. |
static String |
EXECUTION_STATEGY
Refer to @executionStrategy <strategy> . |
static String |
GOAL
The name for the Mojo that users will reference to execute it. |
static String |
IMPLEMENTATION
The Mojo's fully-qualified class name. |
static String |
INHERIT_BY_DEFAULT
Allow Mojo inheritance. |
static String |
INSTANTIATION_STRATEGY
Refer to @instantiationStrategy <per-lookup> . |
static String |
LANGUAGE
The implementation language for the Mojo. |
static String |
MULTI_EXECUTION_STRATEGY
Specifies the execution strategy Refer to @attainAlways . |
static String |
PARAMETER
Refer to @parameter ...
Note: Should be defined in a Mojo Field. |
static String |
PARAMETER_ALIAS
This defines an alias which can be used to configure a parameter. |
static String |
PARAMETER_DEFAULT_VALUE
This defines the default value to be injected into this parameter of the Mojo at buildtime. |
static String |
PARAMETER_EXPRESSION
This defines the expression used to calculate the value to be injected into this parameter of the Mojo at buildtime. |
static String |
PARAMETER_IMPLEMENTATION
This defines the default implementation in the case the parameter type is an interface. |
static String |
PARAMETER_PROPERTY
This indicates the base name of the bean properties used to read/write this parameter's value. |
static String |
PHASE
Refer to @phase <phaseName> . |
static String |
READONLY
Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified configuration). |
static String |
REQUIRED
Whether this parameter is required for the Mojo to function Refer to @required . |
static 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 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 String |
REQUIRES_DIRECT_INVOCATION
Refer to @requiresDirectInvocation <true|false> . |
static String |
REQUIRES_ONLINE
Flags this Mojo to run online. |
static String |
REQUIRES_PROJECT
Flags this Mojo to run inside of a project. |
static String |
REQUIRES_REPORTS
Flags this Mojo to run inside reports. |
static String |
SINCE
Refer to @since <deprecated-text>
Note: Could be defined in a Mojo Type or a Mojo Field. |
static 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 |
---|
static final String AGGREGATOR
@aggregator
.
static final String CONFIGURATOR
@configurator <roleHint>
.
static final String DESCRIPTION
@description
.
static final String EXECUTE
@execute ...
.
static final String EXECUTE_GOAL
@execute goal="<goalName>"
.
static final String EXECUTE_LIFECYCLE
@execute lifecycle="<lifecycleId>"
.
static final String EXECUTE_PHASE
@execute phase="<phaseName>"
.
@execute lifecycle="<lifecycleId>" phase="<phaseName>"
.
static final String EXECUTION_STATEGY
@executionStrategy <strategy>
.
static final String GOAL
@goal <goalName>
.
static final String IMPLEMENTATION
@implementation
.
static final String INHERIT_BY_DEFAULT
@inheritByDefault <true|false>
.
static final String INSTANTIATION_STRATEGY
@instantiationStrategy <per-lookup>
.
static final String LANGUAGE
@language
.
static final String MULTI_EXECUTION_STRATEGY
@attainAlways
.
static final String PHASE
@phase <phaseName>
.
static final String REQUIRES_DEPENDENCY_RESOLUTION
compile
, runtime
, and
test
scopes.
@requiresDependencyResolution <requiredScope>
.
static final String REQUIRES_DEPENDENCY_COLLECTION
compile
, runtime
, and
test
scopes.
@requiresDependencyCollection <requiredScope>
.
static final String REQUIRES_DIRECT_INVOCATION
@requiresDirectInvocation <true|false>
.
static final String REQUIRES_ONLINE
@requiresOnline <true|false>
.
static final String REQUIRES_PROJECT
@requiresProject <true|false>
.
static final String REQUIRES_REPORTS
@requiresReports <true|false>
.
static final String COMPONENT
@component ...
.
static final String COMPONENT_ROLE
@component role="..."
.
static final String COMPONENT_ROLEHINT
@component roleHint="..."
.
static final String PARAMETER
@parameter ...
static final String PARAMETER_ALIAS
@parameter alias="..."
.
static final String PARAMETER_DEFAULT_VALUE
@parameter default-value="..."
.
static final String PARAMETER_EXPRESSION
@parameter expression="..."
.
static final String PARAMETER_IMPLEMENTATION
@parameter implementation="..."
.
static final String PARAMETER_PROPERTY
@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.
static final String READONLY
@readonly
.
static final String REQUIRED
@required
.
static final String SINCE
@since <deprecated-text>
static final String DEPRECATED
@deprecated <since-text>
static final String THREAD_SAFE
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |