org.codehaus.mojo.apt
Class AbstractAptMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.codehaus.mojo.apt.AbstractAptMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
ProcessMojo, TestProcessMojo

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

Base mojo for executing apt.

Version:
$Id: AbstractAptMojo.java 6836 2008-04-25 09:11:04Z mark $
Author:
Juraj Burian, Mark Hobson

Field Summary
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AbstractAptMojo()
           
 
Method Summary
 void execute()
          
protected  void executeImpl()
           
protected abstract  List getClasspathElements()
          Gets the project's classpath.
protected abstract  List getCompileSourceRoots()
          The source directories containing the sources to be processed.
protected abstract  Set getExcludes()
          Gets a set of exclusion filters for apt.
protected abstract  Set getIncludes()
          Gets a set of inclusion filters for apt.
protected  String[] getOptions()
          Gets the options to pass to annotation processors.
protected abstract  File getOutputDirectory()
          The directory root under which processor-generated source files will be placed; files are placed in subdirectories based on package namespace.
protected  org.apache.maven.project.MavenProject getProject()
          Gets the Maven project.
protected abstract  List getResources()
          Gets the project's resources.
 
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
 

Constructor Detail

AbstractAptMojo

public AbstractAptMojo()
Method Detail

execute

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

Throws:
org.apache.maven.plugin.MojoExecutionException

executeImpl

protected void executeImpl()
                    throws org.apache.maven.plugin.MojoExecutionException
Throws:
org.apache.maven.plugin.MojoExecutionException

getProject

protected org.apache.maven.project.MavenProject getProject()
Gets the Maven project.

Returns:
the project

getOptions

protected String[] getOptions()
Gets the options to pass to annotation processors.

Returns:
an array of options to pass to annotation processors

getCompileSourceRoots

protected abstract List getCompileSourceRoots()
The source directories containing the sources to be processed.

Returns:
list of compilation source roots

getResources

protected abstract List getResources()
Gets the project's resources.

Returns:
the project's resources

getClasspathElements

protected abstract List getClasspathElements()
Gets the project's classpath.

Returns:
a list of classpath elements

getIncludes

protected abstract Set getIncludes()
Gets a set of inclusion filters for apt.

Returns:
a set of inclusion filters

getExcludes

protected abstract Set getExcludes()
Gets a set of exclusion filters for apt.

Returns:
a set of exclusion filters

getOutputDirectory

protected abstract File getOutputDirectory()
The directory root under which processor-generated source files will be placed; files are placed in subdirectories based on package namespace.

Returns:
the directory root under which processor-generated source files will be placed


Copyright © 2006-2011 The Codehaus Mojo Project. All Rights Reserved.