rat.anttasks
Class Report

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by rat.anttasks.Report
All Implemented Interfaces:
Cloneable

public class Report
extends org.apache.tools.ant.Task

A basic Ant task that generates a report on all files specified by the nested resource collection(s).

ILicenseMatcher(s) can be specified as nested elements as well.


Field Summary
 
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
Report()
           
 
Method Summary
 void add(IHeaderMatcher matcher)
          Adds a license matcher.
 void add(ILicenseFamily license)
           
 void add(org.apache.tools.ant.types.ResourceCollection rc)
          Adds resources that will be checked.
 void execute()
          Generates the report.
 void setAddDefaultLicenseMatchers(boolean b)
          Whether to add the default list of license matchers.
 void setReportFile(File f)
          Where to send the report to.
 
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
 

Constructor Detail

Report

public Report()
Method Detail

add

public void add(org.apache.tools.ant.types.ResourceCollection rc)
Adds resources that will be checked.


add

public void add(IHeaderMatcher matcher)
Adds a license matcher.


add

public void add(ILicenseFamily license)

setAddDefaultLicenseMatchers

public void setAddDefaultLicenseMatchers(boolean b)
Whether to add the default list of license matchers.


setReportFile

public void setReportFile(File f)
Where to send the report to.


execute

public void execute()
Generates the report.

Overrides:
execute in class org.apache.tools.ant.Task


Copyright © 2006-2011. All Rights Reserved.