org.nanoko.coffee.mill.mojos
Class AbstractReportingCoffeeMillMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.nanoko.coffee.mill.mojos.AbstractCoffeeMillMojo
          org.nanoko.coffee.mill.mojos.AbstractReportingCoffeeMillMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CSSLintReportMillMojo, JSHintReportMillMojo, JSLintReportMillMojo

public abstract class AbstractReportingCoffeeMillMojo
extends AbstractCoffeeMillMojo
implements org.apache.maven.reporting.MavenReport

Field Summary

File	assetsDir Where are the assets.
File	baseDirectory Base directory of the project.
File	buildDirectory Directory containing the build files.
File	coffeeScriptDir Where are CoffeeScript files.
File	coffeeScriptTestDir Where are CoffeeScript files implementing tests.
File	javaScriptDir Where are JavaScript files.
File	javaScriptTestDir Where are JavaScript files implementing tests.
File	libDir Where are the dependencies copies.
org.apache.maven.project.MavenProject	project The maven project.
org.apache.maven.project.MavenProjectHelper	projectHelper Maven ProjectHelper.
protected org.apache.maven.doxia.siterenderer.Renderer	siteRenderer
File	stylesheetsDir Where are LESS, CSS and SASS/SCSS files.
File	workDir Where are the output files written.
File	workTestDir Where are the output test files written.

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

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

ROLE

Constructor Summary

AbstractReportingCoffeeMillMojo()

Method Summary

boolean	canGenerateReport()
protected void	closeReport()
void	execute() This method is called when the report generation is invoked directly as a standalone Mojo.
void	executeReport(Locale locale)
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale) This method is called when the report generation is invoked by maven-site-plugin.
String	getCategoryName()
File	getLibDirectory()
protected String	getOutputDirectory()
protected org.apache.maven.project.MavenProject	getProject()
File	getReportOutputDirectory()
org.apache.maven.doxia.sink.Sink	getSink()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
File	getTarget()
File	getWorkDirectory()
File	getWorkTestDirectory()
boolean	isExternalReport()
void	setReportOutputDirectory(File reportOutputDirectory)
abstract Map<File,List<Processor.ProcessorWarning>>	validate()
abstract void	writeIntroduction()

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.reporting.MavenReport

getDescription, getName, getOutputName

Field Detail

project

public org.apache.maven.project.MavenProject project

The maven project.

projectHelper

public org.apache.maven.project.MavenProjectHelper projectHelper

Maven ProjectHelper.

buildDirectory

public File buildDirectory

Directory containing the build files.

baseDirectory

public File baseDirectory

Base directory of the project.

javaScriptDir

public File javaScriptDir

Where are JavaScript files.

coffeeScriptDir

public File coffeeScriptDir

Where are CoffeeScript files.

coffeeScriptTestDir

public File coffeeScriptTestDir

Where are CoffeeScript files implementing tests.

javaScriptTestDir

public File javaScriptTestDir

Where are JavaScript files implementing tests.

assetsDir

public File assetsDir

Where are the assets.

stylesheetsDir

public File stylesheetsDir

Where are LESS, CSS and SASS/SCSS files.

workDir

public File workDir

Where are the output files written.

workTestDir

public File workTestDir

Where are the output test files written.

libDir

public File libDir

Where are the dependencies copies.

siteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer

Constructor Detail

AbstractReportingCoffeeMillMojo

public AbstractReportingCoffeeMillMojo()

Method Detail

getTarget

public File getTarget()

Overrides:

getTarget in class AbstractCoffeeMillMojo

getWorkDirectory

public File getWorkDirectory()

Overrides:

getWorkDirectory in class AbstractCoffeeMillMojo

getWorkTestDirectory

public File getWorkTestDirectory()

Overrides:

getWorkTestDirectory in class AbstractCoffeeMillMojo

getLibDirectory

public File getLibDirectory()

Overrides:

getLibDirectory in class AbstractCoffeeMillMojo

getProject

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

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

getOutputDirectory

protected String getOutputDirectory()

execute

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

This method is called when the report generation is invoked directly as a standalone Mojo.

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException - if an error uccurs when generating the report

See Also:

Mojo.execute()

generate

public void generate(org.codehaus.doxia.sink.Sink sink,
                     Locale locale)
              throws org.apache.maven.reporting.MavenReportException

This method is called when the report generation is invoked by maven-site-plugin.

Specified by:

generate in interface org.apache.maven.reporting.MavenReport

Throws:

org.apache.maven.reporting.MavenReportException

See Also:

MavenReport.generate(org.codehaus.doxia.sink.Sink, java.util.Locale)

closeReport

protected void closeReport()

getCategoryName

public String getCategoryName()

Specified by:

getCategoryName in interface org.apache.maven.reporting.MavenReport

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

getSink

public org.apache.maven.doxia.sink.Sink getSink()

Returns:

the sink used

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

Returns:

false by default.

See Also:

MavenReport.isExternalReport()

writeIntroduction

public abstract void writeIntroduction()

validate

public abstract Map<File,List<Processor.ProcessorWarning>> validate()
                                                             throws Processor.ProcessorException

Throws:

Processor.ProcessorException

executeReport

public void executeReport(Locale locale)
                   throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException