com.github.danielflower.mavenplugins.gitlog

Class GenerateReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.danielflower.mavenplugins.gitlog.GenerateMojo

com.github.danielflower.mavenplugins.gitlog.GenerateReport

All Implemented Interfaces:

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

@Mojo(name="report")
public class GenerateReport
extends GenerateMojo
implements org.apache.maven.reporting.MavenReport

Goal which generates a changelog based on commits made to the current git repo.

Field Summary

Fields inherited from class com.github.danielflower.mavenplugins.gitlog.GenerateMojo

outputDirectory

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

Constructors

Constructor and Description
GenerateReport()

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport()
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
File	getReportOutputDirectory()
boolean	isExternalReport()
void	setReportOutputDirectory(File file) When running as a reporting plugin, the output directory is fixed, set by the reporting cycle.

Methods inherited from class com.github.danielflower.mavenplugins.gitlog.GenerateMojo

execute

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

Constructor Detail

GenerateReport

public GenerateReport()

Method Detail

generate

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

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

getOutputName

public String getOutputName()

Specified by:

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

getCategoryName

public String getCategoryName()

Specified by:

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

getName

public String getName(Locale locale)

Specified by:

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

getDescription

public String getDescription(Locale locale)

Specified by:

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

setReportOutputDirectory

public void setReportOutputDirectory(File file)

When running as a reporting plugin, the output directory is fixed, set by the reporting cycle.

Specified by:

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

Parameters:

file -

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

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

isExternalReport

public boolean isExternalReport()

Specified by:

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

canGenerateReport

public boolean canGenerateReport()

Specified by:

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