|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
classycle.ant.ClassycleTask
classycle.ant.ReportTask
public class ReportTask
Ant Task for creating a Classycle Analyser report, either raw, CSV, or XML.
| 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. |
| Field Summary | |
|---|---|
static java.lang.String |
TYPE_CSV
|
static java.lang.String |
TYPE_RAW
|
static java.lang.String |
TYPE_XML
|
| Fields inherited from class classycle.ant.ClassycleTask |
|---|
_reportFile |
| Fields inherited from class org.apache.tools.ant.Task |
|---|
target, taskName, taskType, wrapper |
| Fields inherited from class org.apache.tools.ant.ProjectComponent |
|---|
description, location, project |
| Constructor Summary | |
|---|---|
ReportTask()
|
|
| Method Summary | |
|---|---|
void |
execute()
|
void |
setPackagesOnly(boolean packagesOnly)
|
void |
setReportType(java.lang.String csvFile)
|
void |
setTitle(java.lang.String title)
|
| Methods inherited from class classycle.ant.ClassycleTask |
|---|
add, getClassFileNames, getPattern, getReflectionPattern, isMergeInnerClasses, setExcludingClasses, setIncludingClasses, setMergeInnerClasses, setReflectionPattern, setReportFile |
| Methods inherited from class org.apache.tools.ant.Task |
|---|
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
| Methods inherited from class org.apache.tools.ant.ProjectComponent |
|---|
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String TYPE_RAW
public static final java.lang.String TYPE_CSV
public static final java.lang.String TYPE_XML
| Constructor Detail |
|---|
public ReportTask()
| Method Detail |
|---|
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 ClassycleTaskorg.apache.tools.ant.BuildException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||