org.apache.maven.plugins.annotations

Annotation Type Mojo

@Documented
 @Retention(value=CLASS)
 @Target(value=TYPE)
 @Inherited
public @interface Mojo

This annotation will mark your class as a Mojo (ie. goal in a Maven plugin).

Since:

3.0

Author:

Olivier Lamy

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name goal name (required).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	aggregator if the Mojo uses the Maven project and its child modules.
String	configurator own configurator class.
LifecyclePhase	defaultPhase default phase to bind your mojo.
String	executionStrategy Deprecated. unused
boolean	inheritByDefault Deprecated. unused
InstantiationStrategy	instantiationStrategy your Mojo instantiation strategy.
ResolutionScope	requiresDependencyCollection the required dependency collection scope.
ResolutionScope	requiresDependencyResolution the required dependency resolution scope.
boolean	requiresDirectInvocation Deprecated. unused
boolean	requiresOnline does this Mojo need to be online to be executed?
boolean	requiresProject does your mojo requires a project to be executed?
boolean	requiresReports Deprecated. unused
boolean	threadSafe is your mojo thread safe (since Maven 3.x)?

Element Detail

name

public abstract String name

goal name (required).

Returns:

the goal name

defaultPhase

public abstract LifecyclePhase defaultPhase

default phase to bind your mojo.

Returns:

the default phase

Default:

org.apache.maven.plugins.annotations.LifecyclePhase.NONE

requiresDependencyResolution

public abstract ResolutionScope requiresDependencyResolution

the required dependency resolution scope.

Returns:

the required dependency resolution scope

Default:

org.apache.maven.plugins.annotations.ResolutionScope.NONE

requiresDependencyCollection

public abstract ResolutionScope requiresDependencyCollection

the required dependency collection scope.

Returns:

the required dependency collection scope

Default:

org.apache.maven.plugins.annotations.ResolutionScope.NONE

instantiationStrategy

public abstract InstantiationStrategy instantiationStrategy

your Mojo instantiation strategy. (Only per-lookup and singleton are supported)

Returns:

the instantiation strategy

Default:

org.apache.maven.plugins.annotations.InstantiationStrategy.PER_LOOKUP

executionStrategy

@Deprecated
public abstract String executionStrategy

Deprecated. unused

execution strategy: once-per-session or always.

Returns:

once-per-session or always

Default:

"once-per-session"

requiresProject

public abstract boolean requiresProject

does your mojo requires a project to be executed?

Returns:

requires a project

Default:

true

requiresReports

@Deprecated
public abstract boolean requiresReports

Deprecated. unused

does your mojo requires a reporting context to be executed?

Returns:

requires a reporting context

Default:

false

aggregator

public abstract boolean aggregator

if the Mojo uses the Maven project and its child modules.

Returns:

uses the Maven project and its child modules

Default:

false

requiresDirectInvocation

@Deprecated
public abstract boolean requiresDirectInvocation

Deprecated. unused

can this Mojo be invoked directly only?

Returns:

invoked directly only

Default:

false

requiresOnline

public abstract boolean requiresOnline

does this Mojo need to be online to be executed?

Returns:

need to be online

Default:

false

inheritByDefault

@Deprecated
public abstract boolean inheritByDefault

Deprecated. unused

Default:

true

configurator

public abstract String configurator

own configurator class.

Returns:

own configurator class

Default:

""

threadSafe

public abstract boolean threadSafe

is your mojo thread safe (since Maven 3.x)?

Returns:

is thread safe

Default:

false