public class ReportTask extends ClassycleTask
Attribute | Description | Required |
---|---|---|
reportFile | Path of the report file. It is either absolute or relative to the base directory. | Yes |
reportType | Type of the report. Has to be either raw, csv, or xml. | No. Default is xml |
title | Title of the XML report. | No. Default is the first file in the file set. |
packagesOnly | If true only packages and their dependencies are analysed and reported (only in XML report). | No. Default is false. |
includingClasses | Comma or space separated list of wild-card patterns of fully-qualified class name which are included in the analysis. Only '*' are recognized as wild-card character. | No. By default all classes defined in the file set are included. |
excludingClasses | Comma or space separated list of wild-card patterns of fully-qualified class name which are excluded from the analysis. Only '*' are recognized as wild-card character. | No. By default no class defined in the file set is excluded. |
mergeInnerClasses | If true all class vertices are merged
with the vertices of the corresponding inner classes.
|
No. Default is false. |
reflectionPattern | Comma or space separated list of wild-card patterns of
fully-qualified class name.
Only '*' are recognized as wild-card character.
If in the code of a class an ordinary string constant matches one of these patterns and if this string constant has a valid syntax for a fully-qualified class name this constant will be treated as a class reference. |
No. By default ordinary string constants are not treated as class references. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
TYPE_CSV |
static java.lang.String |
TYPE_RAW |
static java.lang.String |
TYPE_XML |
_reportFile
Constructor and Description |
---|
ReportTask() |
Modifier and Type | Method and Description |
---|---|
void |
execute() |
void |
setPackagesOnly(boolean packagesOnly) |
void |
setReportType(java.lang.String csvFile) |
void |
setTitle(java.lang.String title) |
addConfiguredFileset, getClassFileNames, getPattern, getReflectionPattern, isMergeInnerClasses, setExcludingClasses, setIncludingClasses, setMergeInnerClasses, setReflectionPattern, setReportFile
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
public static final java.lang.String TYPE_RAW
public static final java.lang.String TYPE_CSV
public static final java.lang.String TYPE_XML
public void setPackagesOnly(boolean packagesOnly)
public void setReportType(java.lang.String csvFile)
public void setTitle(java.lang.String title)
public void execute() throws org.apache.tools.ant.BuildException
execute
in class ClassycleTask
org.apache.tools.ant.BuildException