Package org.apache.maven.model

Class Reporting

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, InputLocationTracker
    public class Reporting
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, InputLocationTracker
    Section for management of reports and their configuration.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Field Detail

      • excludeDefaults

        private java.lang.String excludeDefaults
        If true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu. Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean. Default value is false.

      • outputDirectory

        private java.lang.String outputDirectory
        Where to store all of the generated reports. The default is ${project.build.directory}/site.

      • plugins

        private java.util.List<ReportPlugin> plugins
        Field plugins.

      • locations

        private java.util.Map<java.lang.Object,​InputLocation> locations
        Field locations.

      • excludeDefaultsLocation

        private InputLocation excludeDefaultsLocation
        Field excludeDefaultsLocation.

      • outputDirectoryLocation

        private InputLocation outputDirectoryLocation
        Field outputDirectoryLocation.

      • pluginsLocation

        private InputLocation pluginsLocation
        Field pluginsLocation.

      • reportPluginMap

        java.util.Map<java.lang.String,​ReportPlugin> reportPluginMap

    • Constructor Detail

      • Reporting

        public Reporting()

    • Method Detail

      • addPlugin

        public void addPlugin​(ReportPlugin reportPlugin)
        Method addPlugin.
        Parameters:
        reportPlugin -

      • clone

        public Reporting clone()
        Method clone.
        Overrides:
        clone in class java.lang.Object
        Returns:
        Reporting

      • getExcludeDefaults

        public java.lang.String getExcludeDefaults()
        Get if true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu. Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean. Default value is false.
        Returns:
        String

      • setOtherLocation

        public void setOtherLocation​(java.lang.Object key,
                             InputLocation location)
        Parameters:
        key -
        location -

      • getOtherLocation

        private InputLocation getOtherLocation​(java.lang.Object key)
        Parameters:
        key -
        Returns:
        InputLocation

      • getOutputDirectory

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

      • getPlugins

        public java.util.List<ReportPlugin> getPlugins()
        Method getPlugins.
        Returns:
        List

      • removePlugin

        public void removePlugin​(ReportPlugin reportPlugin)
        Method removePlugin.
        Parameters:
        reportPlugin -

      • setExcludeDefaults

        public void setExcludeDefaults​(java.lang.String excludeDefaults)
        Set if true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu. Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean. Default value is false.
        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<ReportPlugin> plugins)
        Set the reporting plugins to use and their configuration.
        Parameters:
        plugins -

      • isExcludeDefaults

        public boolean isExcludeDefaults()

      • setExcludeDefaults

        public void setExcludeDefaults​(boolean excludeDefaults)

      • flushReportPluginMap

        public void flushReportPluginMap()
        Reset the reportPluginMap field to null

      • getReportPluginsAsMap

        public java.util.Map<java.lang.String,​ReportPlugin> getReportPluginsAsMap()
        Returns:
        a Map of plugins field with ReportPlugin#getKey() as key
        See Also:
        ReportPlugin.getKey()