public class Report extends BaseAntTask
IHeaderMatcher(s) can be specified as nested elements as well.
The attribute format
defines the output format and can take the
values
Modifier and Type | Class and Description |
---|---|
static class |
Report.AddLicenseHeaders
Deprecated.
No longer required, use stylesheet or xml attributes.
|
static class |
Report.ApprovalFilter
Deprecated.
use listLicenses or listFamilies attributes.
|
BaseAntTask.Child, BaseAntTask.Config, BaseAntTask.Exclude, BaseAntTask.InputExclude, BaseAntTask.LicenseFamiliesApproved, BaseAntTask.LicenseFamiliesApprovedFile, BaseAntTask.LicenseFamiliesDenied, BaseAntTask.LicenseFamiliesDeniedFile, BaseAntTask.Licenses, BaseAntTask.LicensesApproved, BaseAntTask.LicensesApprovedFile, BaseAntTask.LicensesDenied, BaseAntTask.LicensesDeniedFile, BaseAntTask.Out, BaseAntTask.OutputFile
args
Constructor and Description |
---|
Report()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
add(org.apache.tools.ant.types.ResourceCollection rc)
Adds resources that will be checked.
|
void |
addAddApprovedLicense(String familyCategory)
Adds a family category to the list of approved licenses.
|
void |
addFamily(Family family)
Add an inline license family definition to the system.
|
void |
addLicense(License license)
Adds an inline License definition to the system.
|
void |
addRemoveApprovedLicense(String familyCategory)
Removes a family category to the list of approved licenses.
|
void |
addRemoveApprovedLicense(String[] familyCategory)
Removes a family category to the list of approved licenses.
|
void |
addStylesheet(org.apache.tools.ant.types.Resource styleSheet)
Deprecated.
|
void |
addStyleSheet(org.apache.tools.ant.types.Resource styleSheet)
Deprecated.
|
void |
execute()
Generates the report.
|
ReportConfiguration |
getConfiguration()
Creates the ReportConfiguration from the ant options.
|
protected List<String> |
getValues(Arg arg)
Reads values for the Arg.
|
protected void |
removeKey(Arg arg)
Removes the values for the arg.
|
void |
setAddApprovedLicense(String familyCategory)
Deprecated.
use addApprovedLicense child element.
|
void |
setAddDefaultDefinitions(File fileName)
Deprecated.
|
void |
setAddLicenseHeaders(Report.AddLicenseHeaders setting)
Deprecated.
use addLicense and force attributes
|
void |
setCopyrightMessage(String copyrightMessage)
Deprecated.
use copyright attribute
|
void |
setFormat(String style)
Deprecated.
|
void |
setInputFileFilter(org.apache.commons.io.filefilter.IOFileFilter inputFileFilter)
Deprecated.
|
void |
setLicenses(File fileName)
Deprecated.
use licenses child element.
|
void |
setRemoveApprovedLicense(String familyCategory)
Deprecated.
use removeApprovedLicense child element}
|
void |
setRemoveApprovedLicense(String[] familyCategory)
Deprecated.
use removeApprovedLicense element
|
void |
setReportFile(File reportFile)
Deprecated.
|
void |
setStyleReport(boolean styleReport)
Deprecated.
use
BaseAntTask.setXml(boolean) . Note reversal of boolean value |
void |
setUseDefaultLicenses(boolean useDefaultLicenses)
Deprecated.
use noDefaultLicenses attribute
|
protected ReportConfiguration |
validate(ReportConfiguration cfg)
validates the task's configuration.
|
addArg, addArg, args, createConfig, createExclude, createInputExclude, createLicenseFamiliesApproved, createLicenseFamiliesApprovedFile, createLicenseFamiliesDenied, createLicenseFamiliesDeniedFile, createLicenses, createLicensesApproved, createLicensesApprovedFile, createLicensesDenied, createLicensesDeniedFile, createName, createOut, createOutputFile, getArg, removeArg, setAddLicense, setArg, setConfigurationNoDefaults, setCopyright, setDryRun, setEditCopyright, setEditLicense, setEditOverwrite, setExcludeFile, setForce, setHelpLicenses, setInputExcludeFile, setLicenseFamiliesApprovedFile, setLicenseFamiliesDeniedFile, setLicensesApprovedFile, setLicensesDeniedFile, setListFamilies, setListLicenses, setNoDefaultLicenses, setOut, setOutputArchive, setOutputFamilies, setOutputFile, setOutputLicenses, setOutputStandard, setOutputStyle, setScanHiddenDirectories, setStylesheet, setXml, unsupportedArgs
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 void add(org.apache.tools.ant.types.ResourceCollection rc)
rc
- resource to check.@Deprecated public void setInputFileFilter(org.apache.commons.io.filefilter.IOFileFilter inputFileFilter)
inputFileFilter
- The input file filter to add.@Deprecated public void setReportFile(File reportFile)
BaseAntTask.setOut(String)
reportFile
- the report file.public void addLicense(License license)
license
- the license to add.public void addFamily(Family family)
family
- the license family to add.@Deprecated public void addStylesheet(org.apache.tools.ant.types.Resource styleSheet)
BaseAntTask.setStylesheet(String)
styleSheet
- @Deprecated public void addStyleSheet(org.apache.tools.ant.types.Resource styleSheet)
BaseAntTask.setStylesheet(String)
styleSheet
- style sheet to use in this report.@Deprecated public void setStyleReport(boolean styleReport)
BaseAntTask.setXml(boolean)
. Note reversal of boolean valuestyleReport
- @Deprecated public void setFormat(String style)
BaseAntTask.setStylesheet(String)
or BaseAntTask.setXml(boolean)
style
- public void setLicenses(File fileName)
fileName
- the file to add.@Deprecated public void setUseDefaultLicenses(boolean useDefaultLicenses)
useDefaultLicenses
- if true
use the default licenses.@Deprecated public void setAddApprovedLicense(String familyCategory)
familyCategory
- the category to add.public void addAddApprovedLicense(String familyCategory)
familyCategory
- the category to add@Deprecated public void setRemoveApprovedLicense(String familyCategory)
familyCategory
- the category to add.public void addRemoveApprovedLicense(String familyCategory)
familyCategory
- the category to add.@Deprecated public void setRemoveApprovedLicense(String[] familyCategory)
familyCategory
- the category to add.public void addRemoveApprovedLicense(String[] familyCategory)
familyCategory
- the category to add.@Deprecated public void setCopyrightMessage(String copyrightMessage)
copyrightMessage
- the copyright message@Deprecated public void setAddLicenseHeaders(Report.AddLicenseHeaders setting)
setting
- the setting.@Deprecated public void setAddDefaultDefinitions(File fileName)
addLicense(org.apache.rat.anttasks.License)
fileName
- the file to addprotected List<String> getValues(Arg arg)
arg
- The Arg to get the values for.protected void removeKey(Arg arg)
arg
- the arg to remove the values for.public ReportConfiguration getConfiguration()
public void execute()
execute
in class org.apache.tools.ant.Task
protected ReportConfiguration validate(ReportConfiguration cfg)
Copyright © 2006–2024 Apache Software Foundation. All rights reserved.