org.apache.maven.plugin.docck
Class AbstractCheckDocumentationMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugin.docck.AbstractCheckDocumentationMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CheckPluginDocumentationMojo

public abstract class AbstractCheckDocumentationMojo

extends org.apache.maven.plugin.AbstractMojo

Performs the heavy lifting for documentation checks. This is designed to be reused for other types of projects, too.

Author:

jdcasey

Field Summary

protected java.lang.String

siteDirectory Directory where the site source for the project is located.

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

ROLE

Constructor Summary

protected

AbstractCheckDocumentationMojo()

Method Summary

protected abstract boolean	approveProjectPackaging(java.lang.String packaging)
protected abstract void	checkPackagingSpecificDocumentation(org.apache.maven.project.MavenProject project, DocumentationReporter reporter)
void	execute()
protected boolean	findFiles(java.io.File siteDirectory, java.lang.String pattern)
protected java.util.List	getReactorProjects()

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 Detail

siteDirectory

protected java.lang.String siteDirectory

Directory where the site source for the project is located.

Is defined by:

expression:

${siteDirectory}

default-value:

src/site

Constructor Detail

AbstractCheckDocumentationMojo

protected AbstractCheckDocumentationMojo()

Method Detail

getReactorProjects

protected java.util.List getReactorProjects()

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

approveProjectPackaging

protected abstract boolean approveProjectPackaging(java.lang.String packaging)

checkPackagingSpecificDocumentation

protected abstract void checkPackagingSpecificDocumentation(org.apache.maven.project.MavenProject project,
                                                            DocumentationReporter reporter)

findFiles

protected boolean findFiles(java.io.File siteDirectory,
                            java.lang.String pattern)