Class ReportingExtension


  • public class ReportingExtension
    extends Object
    A project extension named "reporting" that provides basic reporting settings and utilities.

    Example usage:

     reporting {
         baseDir "$buildDir/our-reports"
     }
     

    When implementing a task that produces reports, the location of where to generate reports should be obtained via the file(String) method of this extension.

    • Constructor Detail

      • ReportingExtension

        public ReportingExtension​(Project project)
    • Method Detail

      • getBaseDir

        public File getBaseDir()
        The base directory for all reports

        This value can be changed, so any files derived from this should be calculated on demand.

        Returns:
        The base directory for all reports
      • setBaseDir

        public void setBaseDir​(File baseDir)
        Sets the base directory to use for all reports
        Parameters:
        baseDir - The base directory to use for all reports
        Since:
        4.0
      • setBaseDir

        public void setBaseDir​(Object baseDir)
        Sets the base directory to use for all reports

        The value will be converted to a File on demand via Project.file(Object).

        Parameters:
        baseDir - The base directory to use for all reports
      • getBaseDirectory

        @Incubating
        public DirectoryProperty getBaseDirectory()
        Returns base directory property to use for all reports.
        Since:
        4.4
      • file

        public File file​(String path)
        Creates a file object for the given path, relative to getBaseDir().

        The reporting base dir can be changed, so users of this method should use it on demand where appropriate.

        Parameters:
        path - the relative path
        Returns:
        a file object at the given path relative to getBaseDir()
      • getApiDocTitle

        public String getApiDocTitle()