Package org.gradle.api.reporting
Class ReportingExtension
- java.lang.Object
-
- org.gradle.api.reporting.ReportingExtension
-
public abstract class ReportingExtension extends java.lang.ObjectA 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.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringDEFAULT_REPORTS_DIR_NAMEThe default name of the base directory for all reports, relative toProject.getBuildDir()("reports").static java.lang.StringNAMEThe name of this extension (""reporting"")
-
Constructor Summary
Constructors Constructor Description ReportingExtension(Project project)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.io.Filefile(java.lang.String path)Creates a file object for the given path, relative togetBaseDir().java.lang.StringgetApiDocTitle()java.io.FilegetBaseDir()The base directory for all reportsDirectoryPropertygetBaseDirectory()Returns base directory property to use for all reports.ExtensiblePolymorphicDomainObjectContainer<ReportSpec>getReports()Container for aggregation reports, which may be configured automatically in reaction to the presence of the jvm-test-suite plugin.voidsetBaseDir(java.io.File baseDir)Sets the base directory to use for all reportsvoidsetBaseDir(java.lang.Object baseDir)Sets the base directory to use for all reports
-
-
-
Field Detail
-
NAME
public static final java.lang.String NAME
The name of this extension (""reporting"")- See Also:
- Constant Field Values
-
DEFAULT_REPORTS_DIR_NAME
public static final java.lang.String DEFAULT_REPORTS_DIR_NAME
The default name of the base directory for all reports, relative toProject.getBuildDir()("reports").- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ReportingExtension
@Inject public ReportingExtension(Project project)
-
-
Method Detail
-
getBaseDir
public java.io.File getBaseDir()
The base directory for all reportsThis 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(java.io.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(java.lang.Object baseDir)
Sets the base directory to use for all reportsThe value will be converted to a
Fileon demand viaProject.file(Object).- Parameters:
baseDir- The base directory to use for all reports
-
getBaseDirectory
public DirectoryProperty getBaseDirectory()
Returns base directory property to use for all reports.- Since:
- 4.4
-
file
public java.io.File file(java.lang.String path)
Creates a file object for the given path, relative togetBaseDir().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 java.lang.String getApiDocTitle()
-
getReports
@Incubating public ExtensiblePolymorphicDomainObjectContainer<ReportSpec> getReports()
Container for aggregation reports, which may be configured automatically in reaction to the presence of the jvm-test-suite plugin.- Returns:
- A container of known aggregation reports
- Since:
- 7.4
-
-