ch.ifocusit.livingdoc.plugin

Class CommonMojoDefinition

java.lang.Object

org.apache.maven.plugin.AbstractMojo

ch.ifocusit.livingdoc.plugin.CommonMojoDefinition

All Implemented Interfaces:

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

Direct Known Subclasses:

CommonGlossaryMojoDefinition, DiagramMojo

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

Author:

Julien Boz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommonMojoDefinition.Format

Field Summary

Fields

Modifier and Type	Field and Description
protected CommonMojoDefinition.Format	format Output format of the glossary (default html, others : adoc)
protected File	outputDirectory Directory where the glossary will be generated
protected String	outputFilename Output filename
protected org.apache.maven.project.MavenProject	project
protected org.apache.maven.repository.RepositorySystem	repositorySystem
protected Template	template

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

ROLE

Constructor Summary

Constructors

Constructor and Description
CommonMojoDefinition()

Method Summary

Modifier and Type	Method and Description
protected abstract String	getDefaultFilename()
protected String	getFilename()
protected String	getFilenameWithoutExtension()
protected File	getOutput(CommonMojoDefinition.Format desiredExtension)

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

project

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

repositorySystem

@Component
protected org.apache.maven.repository.RepositorySystem repositorySystem

outputDirectory

@Parameter(defaultValue="${project.build.directory}/generated-docs",
           required=true)
protected File outputDirectory

Directory where the glossary will be generated

outputFilename

@Parameter
protected String outputFilename

Output filename

format

@Parameter(defaultValue="html")
protected CommonMojoDefinition.Format format

Output format of the glossary (default html, others : adoc)

template

@Parameter
protected Template template

Constructor Detail

CommonMojoDefinition

public CommonMojoDefinition()

Method Detail

getDefaultFilename

protected abstract String getDefaultFilename()

getFilename

protected String getFilename()

getFilenameWithoutExtension

protected String getFilenameWithoutExtension()

getOutput

protected File getOutput(CommonMojoDefinition.Format desiredExtension)