org.andromda.maven.plugin.site

Class AbstractSiteMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.andromda.maven.plugin.site.AbstractSiteMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

CopyDocumentationMojo, UnpackDocumentationMojo

public abstract class AbstractSiteMojo
extends AbstractMojo

Abstract parent class used by site mojos to perform helper functions like copy and unpack.

Author:

vancek

Field Summary

Fields

Modifier and Type	Field and Description
protected ArchiverManager	archiverManager To look up Archiver/UnArchiver implementations

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractSiteMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	copyFile(File sourceFile, File destFile) Does the actual copy of the file or directory
protected void	unpack(File file, File location) Unpacks the archive file

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

archiverManager

protected ArchiverManager archiverManager

To look up Archiver/UnArchiver implementations

Constructor Detail

AbstractSiteMojo

public AbstractSiteMojo()

Method Detail

copyFile

public void copyFile(File sourceFile,
            File destFile)
              throws MojoExecutionException

Does the actual copy of the file or directory

Parameters:

sourceFile - represents the file to copy.

destFile - file name of destination file.

Throws:

MojoExecutionException - with a message if an error occurs.

unpack

protected void unpack(File file,
          File location)
               throws MojoExecutionException

Unpacks the archive file

Parameters:

file - File to be unpacked.

location - Location where to put the unpacked files.

Throws:

MojoExecutionException