Package org.apache.maven.tools.plugin.extractor.annotations

Class FooMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.tools.plugin.extractor.annotations.AbstractFooMojo

org.apache.maven.tools.plugin.extractor.annotations.FooMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="foo",
      defaultPhase=COMPILE,
      threadSafe=true)
@Execute(goal="compiler",
         lifecycle="my-lifecycle",
         phase=PACKAGE)
public class FooMojo
extends AbstractFooMojo

Author:

Olivier Lamy

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.maven.artifact.metadata.ArtifactMetadataSource	artifactMetadataSource
protected String	bar	the cool bar to go
protected String	beer	Deprecated. wine is better

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
FooMojo()

Method Summary

Modifier and Type	Method	Description
void	addParamFromAdd(String value)	add method as parameter.
void	deprecatedMethod(String value)	Deprecated.
void	execute()
void	setBar(String bar)	Setter method for Parameter field
void	setParamFromSetter(String value)	setter as parameter.
void	setParamFromSetterDeprecated(List<String> value)	Deprecated. reason of deprecation
static void	setStaticMethod(String value)	Static methods should be excluded.

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

bar

@Parameter(property="thebar",
           required=true,
           defaultValue="coolbar")
protected String bar

the cool bar to go

Since:

1.0

beer

@Deprecated
@Parameter(property="thebeer",
           defaultValue="coolbeer")
protected String beer

Deprecated.

wine is better

beer for non french folks

artifactMetadataSource

@Component(role=org.apache.maven.artifact.metadata.ArtifactMetadataSource.class,
           hint="maven")
protected org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource

Constructor Details

FooMojo

public FooMojo()

Method Details

setBar

public void setBar(String bar)

Setter method for Parameter field

setParamFromSetter

@Parameter(property="props.paramFromSetter")
public void setParamFromSetter(String value)

setter as parameter.

addParamFromAdd

@Parameter(property="props.paramFromAdd")
public void addParamFromAdd(String value)

add method as parameter.

setParamFromSetterDeprecated

@Deprecated
@Parameter(property="props.paramFromSetterDeprecated")
public void setParamFromSetterDeprecated(List<String> value)

Deprecated.

reason of deprecation

deprecated setter as parameter.

setStaticMethod

@Parameter
public static void setStaticMethod(String value)

Static methods should be excluded.

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

deprecatedMethod

@Deprecated
public void deprecatedMethod(String value)

Deprecated.