GitHubMojo (Apache Maven Changes Plugin 2.10 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.plugin.github
Class GitHubMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.apache.maven.plugin.changes.AbstractChangesReport
              org.apache.maven.plugin.github.GitHubMojo

All Implemented Interfaces:: ContextEnabled, Mojo, MavenMultiPageReport, MavenReport

@Mojo(name="github-report", threadSafe=true) public class GitHubMojo
extends AbstractChangesReport
extends AbstractChangesReport

Goal which downloads issues from GitHub and generates a report.

Since:: 2.8
Author:: Bryan Baugher

Field Summary

Fields inherited from class org.apache.maven.plugin.changes.AbstractChangesReport
`basedir, factory, i18n, localRepository, mavenSession, project, resolver, runOnlyAtExecutionRoot, siteRenderer`

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
`GitHubMojo()`

Method Summary
`boolean`	`canGenerateReport()`
`protected void`	`executeReport(Locale locale)`
`String`	`getDescription(Locale locale)`
`String`	`getName(Locale locale)`
`String`	`getOutputName()`

Methods inherited from class org.apache.maven.plugin.changes.AbstractChangesReport
`execute, getOutputDirectory, getOutputEncoding, getProject, getSiteRenderer, isThisTheExecutionRoot`

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
`closeReport, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, setReportOutputDirectory`

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

GitHubMojo

public GitHubMojo()

Method Detail

getOutputName

public String getOutputName()

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

canGenerateReport

public boolean canGenerateReport()

Specified by:: canGenerateReport in interface MavenReport
Overrides:: canGenerateReport in class AbstractMavenReport

See Also:: AbstractMavenReport.canGenerateReport()

executeReport

protected void executeReport(Locale locale)
                      throws MavenReportException

Specified by:: executeReport in class AbstractMavenReport

Throws:: MavenReportException