org.apache.maven.model
Class Reporting

java.lang.Object
  extended by org.apache.maven.model.Reporting
All Implemented Interfaces:
java.io.Serializable

public class Reporting
extends java.lang.Object
implements java.io.Serializable

Section for management of reports and their configuration.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
Reporting()
           
 
Method Summary
 void addPlugin(ReportPlugin reportPlugin)
          Method addPlugin
 void flushReportPluginMap()
          Reset the reportPluginMap field to null
 java.lang.String getModelEncoding()
           
 java.lang.String getOutputDirectory()
          Get Where to store all of the generated reports.
 java.util.List getPlugins()
          Method getPlugins
 java.util.Map getReportPluginsAsMap()
           
 boolean isExcludeDefaults()
          Get If true, then the default reports are not included in the site generation.
 void removePlugin(ReportPlugin reportPlugin)
          Method removePlugin
 void setExcludeDefaults(boolean excludeDefaults)
          Set If true, then the default reports are not included in the site generation.
 void setModelEncoding(java.lang.String modelEncoding)
           
 void setOutputDirectory(java.lang.String outputDirectory)
          Set Where to store all of the generated reports.
 void setPlugins(java.util.List plugins)
          Set The reporting plugins to use and their configuration.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Reporting

public Reporting()
Method Detail

addPlugin

public void addPlugin(ReportPlugin reportPlugin)
Method addPlugin

Parameters:
reportPlugin -

getOutputDirectory

public java.lang.String getOutputDirectory()
Get Where to store all of the generated reports. The default is ${project.build.directory}/site .


getPlugins

public java.util.List getPlugins()
Method getPlugins


isExcludeDefaults

public boolean isExcludeDefaults()
Get If true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu.


removePlugin

public void removePlugin(ReportPlugin reportPlugin)
Method removePlugin

Parameters:
reportPlugin -

setExcludeDefaults

public void setExcludeDefaults(boolean excludeDefaults)
Set If true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu.

Parameters:
excludeDefaults -

setOutputDirectory

public void setOutputDirectory(java.lang.String outputDirectory)
Set Where to store all of the generated reports. The default is ${project.build.directory}/site .

Parameters:
outputDirectory -

setPlugins

public void setPlugins(java.util.List plugins)
Set The reporting plugins to use and their configuration.

Parameters:
plugins -

flushReportPluginMap

public void flushReportPluginMap()
Reset the reportPluginMap field to null


getReportPluginsAsMap

public java.util.Map getReportPluginsAsMap()
Returns:
a Map of plugins field with ReportPlugin#getKey() as key
See Also:
ReportPlugin.getKey()

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

getModelEncoding

public java.lang.String getModelEncoding()


Copyright © 2001-2011 Apache Software Foundation. All Rights Reserved.