org.apache.maven.plugin.plugin

Class DescriptorGeneratorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.plugin.AbstractGeneratorMojo

org.apache.maven.plugin.plugin.DescriptorGeneratorMojo

All Implemented Interfaces:

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

@Mojo(name="descriptor",
      defaultPhase=PROCESS_CLASSES,
      requiresDependencyResolution=RUNTIME,
      threadSafe=true)
public class DescriptorGeneratorMojo
extends AbstractGeneratorMojo

Generate a plugin descriptor.
Note: Since 3.0, for Java 5 plugin annotations support, default phase defined by this goal is after the "compilation" of any scripts. This doesn't override the default binding coded at generate-resources phase in Maven core.

Since:

2.0

Version:

$Id$

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	outputDirectory The directory where the generated plugin.xml file will be put.
private boolean	skipDescriptor A flag to disable generation of the plugin.xml in favor of a hand authored plugin descriptor.

Fields inherited from class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

dependencies, encoding, extractors, goalPrefix, local, mojoScanner, packagingTypes, project, remoteRepos, skip, skipErrorNoDescriptorsFound

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

ROLE

Constructor Summary

Constructors

Constructor and Description
DescriptorGeneratorMojo()

Method Summary

Modifier and Type	Method and Description
protected Generator	createGenerator()
void	execute()
protected java.io.File	getOutputDirectory()

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 Detail

outputDirectory

@Parameter(defaultValue="${project.build.outputDirectory}/META-INF/maven")
protected java.io.File outputDirectory

The directory where the generated plugin.xml file will be put.

skipDescriptor

@Parameter(defaultValue="false")
private boolean skipDescriptor

A flag to disable generation of the plugin.xml in favor of a hand authored plugin descriptor.

Since:

2.6

Constructor Detail

DescriptorGeneratorMojo

public DescriptorGeneratorMojo()

Method Detail

getOutputDirectory

protected java.io.File getOutputDirectory()

Specified by:

getOutputDirectory in class AbstractGeneratorMojo

Returns:

the output directory where files will be generated.

createGenerator

protected Generator createGenerator()

Specified by:

createGenerator in class AbstractGeneratorMojo

Returns:

the wanted Generator implementation.

execute

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

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractGeneratorMojo

Throws:

org.apache.maven.plugin.MojoExecutionException