org.nuiton.jaxx.plugin
Class AbstractJaxxMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.nuiton.plugin.AbstractPlugin
          org.nuiton.jaxx.plugin.AbstractJaxxMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractGenerateHelpMojo, GenerateMojo

public abstract class AbstractJaxxMojo
extends org.nuiton.plugin.AbstractPlugin

Abstract Jaxx Mojo.

Since:

1.3

Author:

chemit

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuiton.plugin.Plugin

org.nuiton.plugin.Plugin.Packaging

Field Summary

protected boolean

generateHelp Flag to activate help id detection while parsing jaxx files.

Fields inherited from class org.nuiton.plugin.AbstractPlugin

skipAfterInitMessage

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

ROLE

Constructor Summary

AbstractJaxxMojo()

Method Summary

static boolean	addResourceDir(java.io.File dir, org.apache.maven.project.MavenProject project, java.util.List<?> resources, java.lang.String... includes)
static boolean	addResourceDir(java.io.File dir, org.apache.maven.project.MavenProject project, java.lang.String... includes)
static boolean	addTestResourceDir(java.io.File newresourceDir, org.apache.maven.project.MavenProject project, java.lang.String... includes)
protected boolean	checkPackaging()
protected void	createDirectoryIfNecessary(java.io.File dir) TODO-TC20091221 Should move this to AbstractPlugin Create the directory if necessary.
java.lang.String	getEncoding()
protected java.lang.Long	getLastModified(java.io.File dir)
org.apache.maven.project.MavenProject	getProject()
abstract java.io.File	getTargetDirectory()
boolean	isForce()
boolean	isVerbose()
void	setEncoding(java.lang.String encoding)
void	setForce(boolean force)
void	setProject(org.apache.maven.project.MavenProject project)
abstract void	setTargetDirectory(java.io.File targetDirectory)
void	setVerbose(boolean verbose)

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addUrlToUrlsList, checkResource, checkRunOnceDone, copyFile, doAction, execute, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getTemplate, init, initClassLoader, isExecutionRoot, isFileNewerThanPomFile, rejectPackaging, removeCompileSourceRoots, removeTestCompileSourceRoots, writeFile

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

getLog, setLog

Field Detail

generateHelp

protected boolean generateHelp

Flag to activate help id detection while parsing jaxx files.

By default, not active.

Since:

1.3

Is defined by:

expression:

${jaxx.generateHelp}

default-value:

false

Constructor Detail

AbstractJaxxMojo

public AbstractJaxxMojo()

Method Detail

getTargetDirectory

public abstract java.io.File getTargetDirectory()

setTargetDirectory

public abstract void setTargetDirectory(java.io.File targetDirectory)

checkPackaging

protected boolean checkPackaging()

Overrides:

checkPackaging in class org.nuiton.plugin.AbstractPlugin

getProject

public org.apache.maven.project.MavenProject getProject()

isVerbose

public boolean isVerbose()

setProject

public void setProject(org.apache.maven.project.MavenProject project)

setVerbose

public void setVerbose(boolean verbose)

getEncoding

public java.lang.String getEncoding()

setEncoding

public void setEncoding(java.lang.String encoding)

isForce

public boolean isForce()

setForce

public void setForce(boolean force)

createDirectoryIfNecessary

protected void createDirectoryIfNecessary(java.io.File dir)
                                   throws java.io.IOException

TODO-TC20091221 Should move this to AbstractPlugin Create the directory if necessary.

Parameters:

dir - the directory to create if not already existing

Throws:

java.io.IOException - if could not create the directory

addResourceDir

public static boolean addResourceDir(java.io.File dir,
                                     org.apache.maven.project.MavenProject project,
                                     java.lang.String... includes)

addTestResourceDir

public static boolean addTestResourceDir(java.io.File newresourceDir,
                                         org.apache.maven.project.MavenProject project,
                                         java.lang.String... includes)

addResourceDir

public static boolean addResourceDir(java.io.File dir,
                                     org.apache.maven.project.MavenProject project,
                                     java.util.List<?> resources,
                                     java.lang.String... includes)

getLastModified

protected java.lang.Long getLastModified(java.io.File dir)