org.gradle.api.reporting

クラス ReportingExtension

java.lang.Object

org.gradle.api.reporting.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.

フィールドの概要

フィールド

修飾子とタイプ	フィールドと説明
static String	DEFAULT_REPORTS_DIR_NAME The default name of the base directory for all reports, relative to Project.getBuildDir() ("reports").
static String	NAME The name of this extension (""reporting"")

コンストラクタの概要

コンストラクタ

コンストラクタと説明
ReportingExtension(Project project)

メソッドの概要

修飾子とタイプ	メソッドと説明
File	file(String path) Creates a file object for the given path, relative to getBaseDir().
String	getApiDocTitle()
File	getBaseDir() The base directory for all reports This value can be changed, so any files derived from this should be calculated on demand.
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).

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

NAME

public static final String NAME

The name of this extension (""reporting"")

関連項目:

定数フィールド値

DEFAULT_REPORTS_DIR_NAME

public static final String DEFAULT_REPORTS_DIR_NAME

The default name of the base directory for all reports, relative to Project.getBuildDir() ("reports").

関連項目:

定数フィールド値

コンストラクタの詳細

ReportingExtension

public ReportingExtension(Project project)

メソッドの詳細

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.

戻り値:

The base directory for all reports

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).

パラメータ:

baseDir - The base directory to use for all reports

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.

パラメータ:

path - the relative path

戻り値:

a file object at the given path relative to getBaseDir()

getApiDocTitle

public String getApiDocTitle()