Package org.apache.rat.anttasks

Class Help

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.rat.anttasks.BaseAntTask

org.apache.rat.anttasks.Help

All Implemented Interfaces:

Cloneable

public class Help
extends BaseAntTask

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

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

The attribute format defines the output format and can take the values

• xml - Rat's native XML output.
• styled - transforms the XML output using the given stylesheet. The stylesheet attribute must be set as well if this attribute is used.
• plain - plain text using Rat's built-in stylesheet. This is the default.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Help.AntHelpFormatter

Nested classes/interfaces inherited from class org.apache.rat.anttasks.BaseAntTask

BaseAntTask.Cntr, BaseAntTask.Config, BaseAntTask.CounterMax, BaseAntTask.CounterMin, BaseAntTask.Exclude, BaseAntTask.Expr, BaseAntTask.Filename, BaseAntTask.Include, BaseAntTask.InputExclude, BaseAntTask.InputExcludeParsedScm, BaseAntTask.InputInclude, BaseAntTask.LicenseFamiliesApproved, BaseAntTask.LicenseFamiliesDenied, BaseAntTask.Licenses, BaseAntTask.LicensesApproved, BaseAntTask.LicensesDenied, BaseAntTask.Lst, BaseAntTask.Std, BaseAntTask.TxtValue

Field Summary

Fields inherited from class org.apache.rat.anttasks.BaseAntTask

args

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

Constructors

Constructor	Description
Help()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	execute()	Generates the help.
void	log(String msg, int msgLevel)
void	log(String msg, Throwable t, int msgLevel)

Methods inherited from class org.apache.rat.anttasks.BaseAntTask

addArg, addArg, args, createConfig, createCounterMax, createCounterMin, createExclude, createInclude, createInputExclude, createInputExcludeParsedScm, createInputInclude, createLicenseFamiliesApproved, createLicenseFamiliesDenied, createLicenses, createLicensesApproved, createLicensesDenied, createName, getArg, removeArg, setAddLicense, setArg, setConfigurationNoDefaults, setCopyright, setDryRun, setEditCopyright, setEditLicense, setEditOverwrite, setExcludeFile, setForce, setHelpLicenses, setIncludesFile, setInputExcludeSize, setListFamilies, setListLicenses, setNoDefaultLicenses, setOut, setOutputArchive, setOutputFamilies, setOutputFile, setOutputLicenses, setOutputStandard, setOutputStyle, setScanHiddenDirectories, setStylesheet, setXml, unsupportedArgs

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, 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 Details

Help

public Help()

Constructor.

Method Details

execute

public void execute()

Generates the help.

Overrides:

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

log

public void log(String msg,
 int msgLevel)

Overrides:

log in class org.apache.tools.ant.Task

log

public void log(String msg,
 Throwable t,
 int msgLevel)

Overrides:

log in class org.apache.tools.ant.Task