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

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

@Mojo(name="analyze-report", requiresDependencyResolution=TEST, threadSafe=true) @Execute(phase=TEST_COMPILE) public class AnalyzeReportMojo
extends AbstractMavenReport
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 861760 2013-05-12 17:31:26Z hboutemy $

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

Method Summary
`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, getCategoryName, getReportOutputDirectory, getSink, 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)