org.tentackle.maven

Class AbstractTentackleMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.tentackle.maven.AbstractTentackleMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractTentackleAnnotationProcessingMojo, BeanInfoMojo

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

Base tentackle mojo.

Author:

harald

Field Summary

Fields

Modifier and Type	Field and Description
protected String	charset The encode used to read and write files.
protected List<org.apache.maven.shared.model.fileset.FileSet>	filesets The list of file sets. If set the source directory is ignored.
protected org.apache.maven.project.MavenProject	mavenProject The Maven Project.
protected List<String>	resourceDirs List of resource dirs.
protected String	verbosity The verbosity. One of "default", "info" or "debug".
protected org.wurbelizer.misc.Verbosity	verbosityLevel mapped verbosity level.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractTentackleMojo()

Method Summary

Modifier and Type	Method and Description
protected void	determineEncoding() Determines the encode charset.
protected void	determineVerbosity() sets the verbosity.
protected void	findResourceDirs() Finds all resource directories.
protected String	getCanonicalPath(File dir) Gets the canonical path of diven directory.
protected String	getPathRelativeToBasedir(String path) Gets the path relative to the basedir. Parent dirs of the basedir will also be tried.
protected String	getResourceDirName(String dirName) Checks if given directory resides in resources.
protected void	validate() Checks the configuration.

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

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

execute

Field Detail

mavenProject

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject mavenProject

The Maven Project.

filesets

@Parameter
protected List<org.apache.maven.shared.model.fileset.FileSet> filesets

The list of file sets.
If set the source directory is ignored.

verbosity

@Parameter(defaultValue="${tentackle.verbosity}")
protected String verbosity

The verbosity.
One of "default", "info" or "debug". Debus is also turned on (if not set explicitly) by Maven's global debug flag (see command line switch -X).

charset

@Parameter(defaultValue="${project.build.sourceEncoding}")
protected String charset

The encode used to read and write files.

verbosityLevel

protected org.wurbelizer.misc.Verbosity verbosityLevel

mapped verbosity level.

resourceDirs

protected List<String> resourceDirs

List of resource dirs.

Constructor Detail

AbstractTentackleMojo

public AbstractTentackleMojo()

Method Detail

determineEncoding

protected void determineEncoding()

Determines the encode charset.

determineVerbosity

protected void determineVerbosity()

sets the verbosity.

getPathRelativeToBasedir

protected String getPathRelativeToBasedir(String path)

Gets the path relative to the basedir.
Parent dirs of the basedir will also be tried.

Parameters:

path - the absolute path

Returns:

the shortened path

findResourceDirs

protected void findResourceDirs()

Finds all resource directories.

getResourceDirName

protected String getResourceDirName(String dirName)

Checks if given directory resides in resources.

Parameters:

dirName - the directory name

Returns:

the resource dir, null if not a resource

getCanonicalPath

protected String getCanonicalPath(File dir)
                           throws org.apache.maven.plugin.MojoExecutionException

Gets the canonical path of diven directory.

Parameters:

dir - the directory

Returns:

the path

Throws:

org.apache.maven.plugin.MojoExecutionException - if failed

validate

protected void validate()
                 throws org.apache.maven.plugin.MojoExecutionException

Checks the configuration.

Throws:

org.apache.maven.plugin.MojoExecutionException - if validation failed