org.apache.maven.plugin.plugin
Class AbstractGeneratorMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugin.plugin.AbstractGeneratorMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
DescriptorGeneratorMojo, HelpGeneratorMojo, XdocGeneratorMojo

public abstract class AbstractGeneratorMojo
extends org.apache.maven.plugin.AbstractMojo

Abstract class for this Plugin.

Version:
$Id: AbstractGeneratorMojo.java 940009 2010-05-01 13:32:37Z bentmann $
Author:
Jason van Zyl

Field Summary
protected  String encoding
          The file encoding of the source files.
protected  Set extractors
          The role names of mojo extractors to use.
protected  String goalPrefix
          The goal prefix that will appear before the ":".
protected  MojoScanner mojoScanner
          The component used for scanning the source tree for mojos.
protected  org.apache.maven.project.MavenProject project
          The project currently being built.
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AbstractGeneratorMojo()
           
 
Method Summary
protected abstract  Generator createGenerator()
           
 void execute()
          
protected abstract  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

project

protected org.apache.maven.project.MavenProject project
The project currently being built.


mojoScanner

protected MojoScanner mojoScanner
The component used for scanning the source tree for mojos.


encoding

protected String encoding
The file encoding of the source files.

Since:
2.5

goalPrefix

protected String goalPrefix
The goal prefix that will appear before the ":".


extractors

protected Set extractors
The role names of mojo extractors to use.

If not set, all mojo extractors will be used. If set to an empty extractor name, no mojo extractors will be used.

Example:

  <!-- Use all mojo extractors -->
  <extractors/>
  
  <!-- Use no mojo extractors -->
  <extractors>
      <extractor/>
  </extractors>
  
  <!-- Use only bsh mojo extractor -->
  <extractors>
      <extractor>bsh</extractor>
  </extractors>
 

Constructor Detail

AbstractGeneratorMojo

public AbstractGeneratorMojo()
Method Detail

getOutputDirectory

protected abstract File getOutputDirectory()
Returns:
the output directory where files will be generated.

createGenerator

protected abstract Generator createGenerator()
Returns:
the wanted Generator implementation.

execute

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

Throws:
org.apache.maven.plugin.MojoExecutionException


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