Class AnalyzeReport
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugins.dependency.analyze.AnalyzeReport
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled,org.apache.maven.plugin.Mojo,org.apache.maven.reporting.MavenMultiPageReport,org.apache.maven.reporting.MavenReport
@Mojo(name="analyze-report",
requiresDependencyResolution=TEST,
threadSafe=true)
@Execute(phase=TEST_COMPILE)
public class AnalyzeReport
extends org.apache.maven.reporting.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
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalyzerThe Maven project dependency analyzer to use.List Excluded classes patterns from analyze.private org.codehaus.plexus.i18n.I18NInternationalization componentprivate booleanIgnore Runtime/Provided/Test/System scopes for unused dependency analysisprivate booleanSkip plugin execution completely.private String[]Force dependencies as used, to override incomplete result caused by bytecode-level analysis.Fields inherited from class org.apache.maven.reporting.AbstractMavenReport
locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteToolFields inherited from interface org.apache.maven.reporting.MavenReport
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLEFields inherited from interface org.apache.maven.plugin.Mojo
ROLE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanvoidexecuteReport(Locale locale) getDescription(Locale locale) protected StringgetI18nString(Locale locale, String key) Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, isExternalReport, setReportOutputDirectoryMethods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContextMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.maven.reporting.MavenReport
getOutputPath
-
Field Details
-
analyzer
@Component private org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalyzer analyzerThe Maven project dependency analyzer to use. -
ignoreNonCompile
@Parameter(property="ignoreNonCompile", defaultValue="false") private boolean ignoreNonCompileIgnore Runtime/Provided/Test/System scopes for unused dependency analysis- Since:
- 2.2
-
usedDependencies
Force dependencies as used, to override incomplete result caused by bytecode-level analysis. Dependency format isgroupId:artifactId.- Since:
- 2.6
-
skip
@Parameter(property="mdep.analyze.skip", defaultValue="false") private boolean skipSkip plugin execution completely.- Since:
- 2.7
-
excludedClasses
List Excluded classes patterns from analyze. Java regular expression pattern is applied to full class name.- Since:
- 3.7.0
-
i18n
@Component private org.codehaus.plexus.i18n.I18N i18nInternationalization component
-
-
Constructor Details
-
AnalyzeReport
public AnalyzeReport()
-
-
Method Details
-
executeReport
- Specified by:
executeReportin classorg.apache.maven.reporting.AbstractMavenReport- Throws:
org.apache.maven.reporting.MavenReportException
-
canGenerateReport
public boolean canGenerateReport()- Specified by:
canGenerateReportin interfaceorg.apache.maven.reporting.MavenReport- Overrides:
canGenerateReportin classorg.apache.maven.reporting.AbstractMavenReport
-
getOutputName
-
getName
-
getDescription
-
getI18nString
- Parameters:
locale- The localekey- The key to search for- Returns:
- The text appropriate for the locale.
-