AnalyzeReportMojo (Apache Maven Dependency Plugin 2.10 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.dependency.analyze.AnalyzeReportMojo

All Implemented Interfaces:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport
```
@Mojo(name="analyze-report",
      requiresDependencyResolution=TEST,
      threadSafe=true)
@Execute(phase=TEST_COMPILE)
public class AnalyzeReportMojo
extends AbstractMavenReport
```
Analyzes the dependencies of this project and produces a report that summarizes which are: used and declared; used and undeclared; unused and declared.

Since:

2.0-alpha-5

Version:

$Id: AnalyzeReportMojo.html 937155 2015-01-21 21:53:50Z khmarbaise $

Field Summary
- 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

AnalyzeReportMojo()

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`executeReport(Locale locale)`
`protected ResourceBundle`	`getBundle(Locale locale)`
`String`	`getDescription(Locale locale)`
`String`	`getName(Locale locale)`
`protected String`	`getOutputDirectory()`
`String`	`getOutputName()`
`protected MavenProject`	`getProject()`
`protected Renderer`	`getSiteRenderer()`
`boolean`	`isSkip()`
`void`	`setSkip(boolean skip)`

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
canGenerateReport, closeReport, execute, 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
- AnalyzeReportMojo
```
public AnalyzeReportMojo()
```

Method Detail

executeReport

public void executeReport(Locale locale)
                   throws MavenReportException

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

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

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

getDescription

public String getDescription(Locale locale)

getProject
```
protected MavenProject getProject()
```
Specified by:

getProject in class AbstractMavenReport

getOutputDirectory
```
protected String getOutputDirectory()
```
Specified by:

getOutputDirectory in class AbstractMavenReport

getSiteRenderer
```
protected Renderer getSiteRenderer()
```
Specified by:

getSiteRenderer in class AbstractMavenReport

getBundle

protected ResourceBundle getBundle(Locale locale)

Parameters:: locale - the current locale

isSkip
```
public boolean isSkip()
```

setSkip
```
public void setSkip(boolean skip)
```

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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