org.nuiton.util.config

Class AbstractApplicationConfigReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.nuiton.util.config.AbstractApplicationConfigReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport

Direct Known Subclasses:

AggregateApplicationConfigReport, ApplicationConfigReport

public abstract class AbstractApplicationConfigReport
extends org.apache.maven.reporting.AbstractMavenReport

Abstract application config report used by normal and aggregate report.

Since:

2.6.10

Author:

tchemit

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<ApplicationConfigProvider>	configProviders Set of ApplicationconfigProvider detected from configuration.
protected String	exclude List of application config to exclude from report (separated by comma).
protected org.codehaus.plexus.i18n.I18N	i18n Internationalization component.
protected String	i18nBundleName Optional i18n bundle name as used by the nuiton I18n system to init his files.
protected String	include List of application config to include in report (separated by comma).
protected ClassLoader	newClassLoader Class loader with all compile dependencies of the module in class-path (used to init i18n) and obtain config provider over compile class-path.
protected File	outputDirectory Report output directory.
protected String	outputEncoding Report output encoding.
protected org.apache.maven.project.MavenProject	project The Maven Project.
protected boolean	showOptionDetail Flag to render option in detail (add a section for each option).
protected org.apache.maven.doxia.siterenderer.Renderer	siteRenderer Doxia Site Renderer component.
protected boolean	skip Skip to generate the report.
protected boolean	verbose Flag to activate verbose mode.

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
AbstractApplicationConfigReport()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected abstract ClassLoader	createClassLoader()
protected ClassLoader	createClassLoader(Set<String> paths)
protected void	executeReport(Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
protected String	getOutputDirectory()
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
protected void	init(Locale locale)

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, execute, generate, generate, generate, 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

outputDirectory

@Parameter(property="config.outputDirectory",
           defaultValue="${project.reporting.outputDirectory}",
           required=true)
protected File outputDirectory

Report output directory. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.

Since:

2.6.10

outputEncoding

@Parameter(property="config.outputEncoding",
           defaultValue="${project.reporting.outputEncoding}",
           required=true)
protected String outputEncoding

Report output encoding. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output encoding configured in the Maven Site Plugin is used instead.

Since:

2.6.10

i18nBundleName

@Parameter(property="config.i18nBundleName")
protected String i18nBundleName

Optional i18n bundle name as used by the nuiton I18n system to init his files.

If not given, will look at all i18n files in all over class-path (which could be costy if many dependencies), otherwise will init I18n system usinga DefaultI18nInitializer with this bundle name.

Since:

2.6.10

include

@Parameter(property="config.include")
protected String include

List of application config to include in report (separated by comma).

Note: If not filled then will use all config found in class-path.

Since:

2.6.10

exclude

@Parameter(property="config.exclude")
protected String exclude

List of application config to exclude from report (separated by comma).

Note: If not filled no config will be exclude.

Since:

2.6.10

verbose

@Parameter(property="config.verbose",
           defaultValue="${maven.verbose}")
protected boolean verbose

Flag to activate verbose mode.

Note: Verbose mode is always on if you starts a debug maven instance (says via -X).

Since:

2.6.10

showOptionDetail

@Parameter(property="config.showOptionDetail",
           defaultValue="true")
protected boolean showOptionDetail

Flag to render option in detail (add a section for each option).

Since:

2.6.10

skip

@Parameter(property="config.skip")
protected boolean skip

Skip to generate the report.

Since:

2.6.10

project

@Component
protected org.apache.maven.project.MavenProject project

The Maven Project.

Since:

2.6.10

siteRenderer

@Component
protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer

Doxia Site Renderer component.

Since:

2.6.10

i18n

@Component
protected org.codehaus.plexus.i18n.I18N i18n

Internationalization component.

Since:

2.6.10

newClassLoader

protected ClassLoader newClassLoader

Class loader with all compile dependencies of the module in class-path (used to init i18n) and obtain config provider over compile class-path.

Since:

2.6.10

configProviders

protected Set<ApplicationConfigProvider> configProviders

Set of ApplicationconfigProvider detected from configuration.

Since:

2.6.10

Constructor Detail

AbstractApplicationConfigReport

public AbstractApplicationConfigReport()

Method Detail

getOutputName

public String getOutputName()

getDescription

public String getDescription(Locale locale)

getName

public String getName(Locale locale)

getCategoryName

public String getCategoryName()

Specified by:

getCategoryName in interface org.apache.maven.reporting.MavenReport

Overrides:

getCategoryName in class org.apache.maven.reporting.AbstractMavenReport

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

Overrides:

canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Specified by:

getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

getOutputDirectory

protected String getOutputDirectory()

Specified by:

getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

getProject

protected org.apache.maven.project.MavenProject getProject()

Specified by:

getProject in class org.apache.maven.reporting.AbstractMavenReport

createClassLoader

protected abstract ClassLoader createClassLoader()
                                          throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

executeReport

protected void executeReport(Locale locale)
                      throws org.apache.maven.reporting.MavenReportException

Specified by:

executeReport in class org.apache.maven.reporting.AbstractMavenReport

Throws:

org.apache.maven.reporting.MavenReportException

init

protected void init(Locale locale)
             throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

createClassLoader

protected ClassLoader createClassLoader(Set<String> paths)