Package classycle.ant

Class ReportTask

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
classycle.ant.ClassycleTask
classycle.ant.ReportTask
All Implemented Interfaces:
Cloneable
public class ReportTask extends ClassycleTask
Ant Task for creating a Classycle Analyser report, either raw, CSV, or XML.

AttributeDescriptionRequired
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.
Author:
Boris Gruschko, Franz-Josef Elmer

  • Field Details

  • Constructor Details

    • ReportTask

      public ReportTask()

  • Method Details

    • setPackagesOnly

      public void setPackagesOnly(boolean packagesOnly)

    • setReportType

      public void setReportType(String csvFile)

    • setTitle

      public void setTitle(String title)

    • execute

      public void execute() throws org.apache.tools.ant.BuildException
      Overrides:
      execute in class ClassycleTask
      Throws:
      org.apache.tools.ant.BuildException