public class Reporting extends java.lang.Object implements java.io.Serializable, java.lang.Cloneable, InputLocationTracker
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
excludeDefaults
If true, then the default reports are not
included in the site generation.
|
private InputLocation |
excludeDefaultsLocation
Field excludeDefaultsLocation.
|
private InputLocation |
location
Field location.
|
private java.util.Map<java.lang.Object,InputLocation> |
locations
Field locations.
|
private java.lang.String |
outputDirectory
Where to store all of the generated reports.
|
private InputLocation |
outputDirectoryLocation
Field outputDirectoryLocation.
|
private java.util.List<ReportPlugin> |
plugins
Field plugins.
|
private InputLocation |
pluginsLocation
Field pluginsLocation.
|
(package private) java.util.Map<java.lang.String,ReportPlugin> |
reportPluginMap |
Constructor and Description |
---|
Reporting() |
Modifier and Type | Method and Description |
---|---|
void |
addPlugin(ReportPlugin reportPlugin)
Method addPlugin.
|
Reporting |
clone()
Method clone.
|
void |
flushReportPluginMap()
Reset the
reportPluginMap field to null |
java.lang.String |
getExcludeDefaults()
Get if true, then the default reports are not included in
the site generation.
|
InputLocation |
getLocation(java.lang.Object key)
Gets the location of the specified field in the input
source.
|
private InputLocation |
getOtherLocation(java.lang.Object key) |
java.lang.String |
getOutputDirectory()
Get where to store all of the generated reports.
|
java.util.List<ReportPlugin> |
getPlugins()
Method getPlugins.
|
java.util.Map<java.lang.String,ReportPlugin> |
getReportPluginsAsMap() |
boolean |
isExcludeDefaults() |
void |
removePlugin(ReportPlugin reportPlugin)
Method removePlugin.
|
void |
setExcludeDefaults(boolean excludeDefaults) |
void |
setExcludeDefaults(java.lang.String excludeDefaults)
Set if true, then the default reports are not included in
the site generation.
|
void |
setLocation(java.lang.Object key,
InputLocation location)
Sets the location of the specified field.
|
void |
setOtherLocation(java.lang.Object key,
InputLocation location) |
void |
setOutputDirectory(java.lang.String outputDirectory)
Set where to store all of the generated reports.
|
void |
setPlugins(java.util.List<ReportPlugin> plugins)
Set the reporting plugins to use and their configuration.
|
private java.lang.String excludeDefaults
String
for
technical reasons, the semantic type is actually
Boolean
. Default value is
false
.private java.lang.String outputDirectory
${project.build.directory}/site
.private java.util.List<ReportPlugin> plugins
private java.util.Map<java.lang.Object,InputLocation> locations
private InputLocation location
private InputLocation excludeDefaultsLocation
private InputLocation outputDirectoryLocation
private InputLocation pluginsLocation
java.util.Map<java.lang.String,ReportPlugin> reportPluginMap
public void addPlugin(ReportPlugin reportPlugin)
reportPlugin
- public Reporting clone()
clone
in class java.lang.Object
public java.lang.String getExcludeDefaults()
String
for
technical reasons, the semantic type is actually
Boolean
. Default value is
false
.public InputLocation getLocation(java.lang.Object key)
InputLocationTracker
getLocation
in interface InputLocationTracker
key
- public void setLocation(java.lang.Object key, InputLocation location)
InputLocationTracker
setLocation
in interface InputLocationTracker
key
- location
- public void setOtherLocation(java.lang.Object key, InputLocation location)
key
- location
- private InputLocation getOtherLocation(java.lang.Object key)
key
- public java.lang.String getOutputDirectory()
${project.build.directory}/site
.public java.util.List<ReportPlugin> getPlugins()
public void removePlugin(ReportPlugin reportPlugin)
reportPlugin
- public void setExcludeDefaults(java.lang.String excludeDefaults)
String
for
technical reasons, the semantic type is actually
Boolean
. Default value is
false
.excludeDefaults
- public void setOutputDirectory(java.lang.String outputDirectory)
${project.build.directory}/site
.outputDirectory
- public void setPlugins(java.util.List<ReportPlugin> plugins)
plugins
- public boolean isExcludeDefaults()
public void setExcludeDefaults(boolean excludeDefaults)
public void flushReportPluginMap()
reportPluginMap
field to null
public java.util.Map<java.lang.String,ReportPlugin> getReportPluginsAsMap()
ReportPlugin#getKey()
as keyReportPlugin.getKey()