Package ch.so.agi.hop.doclint.mojo

Class AbstractDocLintMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

ch.so.agi.hop.doclint.mojo.AbstractDocLintMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CheckMojo, DocumentationMojo, MetadataMojo, SamplesMojo

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

Base implementation of the DocLint goals.

Every module runs the goals against its own compiled classes. Modules without Hop plugin annotations are skipped, which makes the configuration work for multi-module repositories with core and assembly modules. docs/ and examples/ default to the top-level project directory because they live next to the aggregator POM.

Field Summary

Fields

Modifier and Type	Field	Description
protected File	classesDirectory
protected File	docsDirectory
protected File	examplesDirectory
protected org.apache.maven.project.MavenProject	project
protected boolean	requireDocumentation
protected boolean	requireExamples
protected boolean	requireKeywords
protected org.apache.maven.execution.MavenSession	session
protected boolean	skip

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

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractDocLintMojo()

Method Summary

Modifier and Type	Method	Description
protected abstract boolean	documentationEnabled()
void	execute()
protected abstract boolean	metadataEnabled()
protected abstract boolean	samplesEnabled()

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

Field Details

project

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

session

@Parameter(defaultValue="${session}",
           readonly=true,
           required=true)
protected org.apache.maven.execution.MavenSession session

classesDirectory

@Parameter(defaultValue="${project.build.outputDirectory}",
           readonly=true,
           required=true)
protected File classesDirectory

docsDirectory

@Parameter(property="hop.plugin.doclint.docsDirectory")
protected File docsDirectory

examplesDirectory

@Parameter(property="hop.plugin.doclint.examplesDirectory")
protected File examplesDirectory

requireKeywords

@Parameter(property="hop.plugin.doclint.requireKeywords",
           defaultValue="true")
protected boolean requireKeywords

requireDocumentation

@Parameter(property="hop.plugin.doclint.requireDocumentation",
           defaultValue="true")
protected boolean requireDocumentation

requireExamples

@Parameter(property="hop.plugin.doclint.requireExamples",
           defaultValue="true")
protected boolean requireExamples

skip

@Parameter(property="hop.plugin.doclint.skip",
           defaultValue="false")
protected boolean skip

Constructor Details

AbstractDocLintMojo

public AbstractDocLintMojo()

Method Details

metadataEnabled

protected abstract boolean metadataEnabled()

documentationEnabled

protected abstract boolean documentationEnabled()

samplesEnabled

protected abstract boolean samplesEnabled()

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException