ChangesMojo (Apache Maven Changes Plugin 2.12.1 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.reporting.AbstractMavenReport
  - - org.apache.maven.plugin.changes.AbstractChangesReport
    - - org.apache.maven.plugin.changes.ChangesMojo

All Implemented Interfaces:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport
```
@Mojo(name="changes-report",
      threadSafe=true)
public class ChangesMojo
extends AbstractChangesReport
```
Goal which creates a nicely formatted Changes Report in html format from a changes.xml file.

Version:

$Id: ChangesMojo.java 1742353 2016-05-05 03:22:53Z schulte $

Author:

Johnny R. Ruiz III

Field Summary

Fields
Modifier and Type Field and Description

protected MavenSession session
- 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

Constructors
Constructor and Description

ChangesMojo()

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canGenerateReport()`
`void`	`executeReport(Locale locale)`
`String`	`getDescription(Locale locale)`
`String`	`getName(Locale locale)`
`String`	`getOutputName()`
`protected String`	`getTeamlist()`

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, getInputEncoding, 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

Field Detail

session

@Parameter(defaultValue="${session}",
           readonly=true,
           required=true)
protected MavenSession session

Since:: 2.2

Constructor Detail
- ChangesMojo
```
public ChangesMojo()
```

Method Detail

canGenerateReport
```
public boolean canGenerateReport()
```
Specified by:

canGenerateReport in interface MavenReport

Overrides:

canGenerateReport in class AbstractMavenReport

executeReport

public void executeReport(Locale locale)
                   throws MavenReportException

Specified by:: executeReport in class AbstractMavenReport
Throws:: MavenReportException

getDescription

public String getDescription(Locale locale)

getName
```
public String getName(Locale locale)
```

getOutputName
```
public String getOutputName()
```

getTeamlist
```
protected String getTeamlist()
```

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2002–2016 The Apache Software Foundation. All rights reserved.