Index
All Classes and Interfaces|All Packages
A
- add(IHeaderMatcher) - Method in class org.apache.rat.anttasks.License
-
Deprecated.
- add(IHeaderMatcher.Builder) - Method in class org.apache.rat.anttasks.All
-
Deprecated.
- add(IHeaderMatcher.Builder) - Method in class org.apache.rat.anttasks.Any
-
Deprecated.
- add(IHeaderMatcher.Builder) - Method in class org.apache.rat.anttasks.License
-
Deprecated.
- add(IHeaderMatcher.Builder) - Method in class org.apache.rat.anttasks.Not
-
Deprecated.
- add(ResourceCollection) - Method in class org.apache.rat.anttasks.Report
-
Adds resources that will be checked.
- addAddApprovedLicense(String) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.use licensesFamiliesApproved child element
- addArg(String, String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Add a value to the key in the argument list.
- addArg(String, String[]) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Add values to the key in the argument list.
- addConfiguredCntr(BaseAntTask.Cntr) - Method in class org.apache.rat.anttasks.BaseAntTask.CounterMax
- addConfiguredCntr(BaseAntTask.Cntr) - Method in class org.apache.rat.anttasks.BaseAntTask.CounterMin
- addConfiguredExpr(BaseAntTask.Expr) - Method in class org.apache.rat.anttasks.BaseAntTask.Exclude
- addConfiguredExpr(BaseAntTask.Expr) - Method in class org.apache.rat.anttasks.BaseAntTask.Include
- addConfiguredExpr(BaseAntTask.Expr) - Method in class org.apache.rat.anttasks.BaseAntTask.InputExclude
- addConfiguredExpr(BaseAntTask.Expr) - Method in class org.apache.rat.anttasks.BaseAntTask.InputInclude
- addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.Config
- addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.InputExclude
- addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.InputInclude
- addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.LicenseFamiliesApproved
- addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.LicenseFamiliesDenied
- addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.Licenses
- addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.LicensesApproved
- addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.LicensesDenied
- addConfiguredLst(BaseAntTask.Lst) - Method in class org.apache.rat.anttasks.BaseAntTask.LicenseFamiliesApproved
- addConfiguredLst(BaseAntTask.Lst) - Method in class org.apache.rat.anttasks.BaseAntTask.LicenseFamiliesDenied
- addConfiguredLst(BaseAntTask.Lst) - Method in class org.apache.rat.anttasks.BaseAntTask.LicensesApproved
- addConfiguredLst(BaseAntTask.Lst) - Method in class org.apache.rat.anttasks.BaseAntTask.LicensesDenied
- addConfiguredStd(BaseAntTask.Std) - Method in class org.apache.rat.anttasks.BaseAntTask.InputExclude
- addConfiguredStd(BaseAntTask.Std) - Method in class org.apache.rat.anttasks.BaseAntTask.InputExcludeParsedScm
- addConfiguredStd(BaseAntTask.Std) - Method in class org.apache.rat.anttasks.BaseAntTask.InputInclude
- addFamily(Family) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.Create a custom configuration file and use the config option.
- addLicense(License) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.Create a custom configuration file and use the config option.
- AddLicenseHeaders() - Constructor for class org.apache.rat.anttasks.Report.AddLicenseHeaders
-
Deprecated.
- AddLicenseHeaders(String) - Constructor for class org.apache.rat.anttasks.Report.AddLicenseHeaders
-
Deprecated.
- addNotes(String) - Method in class org.apache.rat.anttasks.License
-
Deprecated.
- addRemoveApprovedLicense(String) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.use licensesFamiliesDenied child element
- addRemoveApprovedLicense(String[]) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.use licenseFamilyDenied element
- addStylesheet(Resource) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.
- addStyleSheet(Resource) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.
- addText(String) - Method in class org.apache.rat.anttasks.BaseAntTask.TxtValue
- addText(String) - Method in class org.apache.rat.anttasks.Regex
-
Deprecated.
- addText(String) - Method in class org.apache.rat.anttasks.Spdx
-
Deprecated.
- addText(String) - Method in class org.apache.rat.anttasks.Text
-
Deprecated.
- All - Class in org.apache.rat.anttasks
-
Deprecated.use configuration file.
- All() - Constructor for class org.apache.rat.anttasks.All
-
Deprecated.
- AntHelpFormatter() - Constructor for class org.apache.rat.anttasks.Help.AntHelpFormatter
- Any - Class in org.apache.rat.anttasks
-
Deprecated.use configuration file.
- Any() - Constructor for class org.apache.rat.anttasks.Any
-
Deprecated.
- ApprovalFilter() - Constructor for class org.apache.rat.anttasks.Report.ApprovalFilter
-
Deprecated.
- ApprovalFilter(String) - Constructor for class org.apache.rat.anttasks.Report.ApprovalFilter
-
Deprecated.
- args - Variable in class org.apache.rat.anttasks.BaseAntTask
-
A map of CLI-based arguments to values.
- args() - Method in class org.apache.rat.anttasks.BaseAntTask
-
Gets the list of arguments prepared for the CLI code to parse.
B
- BaseAntTask - Class in org.apache.rat.anttasks
-
Generated class to provide Ant support for standard RAT command line options.
- BaseAntTask() - Constructor for class org.apache.rat.anttasks.BaseAntTask
- BaseAntTask.Cntr - Class in org.apache.rat.anttasks
- BaseAntTask.Config - Class in org.apache.rat.anttasks
- BaseAntTask.CounterMax - Class in org.apache.rat.anttasks
- BaseAntTask.CounterMin - Class in org.apache.rat.anttasks
- BaseAntTask.Exclude - Class in org.apache.rat.anttasks
- BaseAntTask.Expr - Class in org.apache.rat.anttasks
- BaseAntTask.Filename - Class in org.apache.rat.anttasks
- BaseAntTask.Include - Class in org.apache.rat.anttasks
- BaseAntTask.InputExclude - Class in org.apache.rat.anttasks
- BaseAntTask.InputExcludeParsedScm - Class in org.apache.rat.anttasks
- BaseAntTask.InputInclude - Class in org.apache.rat.anttasks
- BaseAntTask.LicenseFamiliesApproved - Class in org.apache.rat.anttasks
- BaseAntTask.LicenseFamiliesDenied - Class in org.apache.rat.anttasks
- BaseAntTask.Licenses - Class in org.apache.rat.anttasks
- BaseAntTask.LicensesApproved - Class in org.apache.rat.anttasks
- BaseAntTask.LicensesDenied - Class in org.apache.rat.anttasks
- BaseAntTask.Lst - Class in org.apache.rat.anttasks
- BaseAntTask.Std - Class in org.apache.rat.anttasks
- BaseAntTask.TxtValue - Class in org.apache.rat.anttasks
- build() - Method in class org.apache.rat.anttasks.All
-
Deprecated.
- build() - Method in class org.apache.rat.anttasks.Any
-
Deprecated.
- build() - Method in class org.apache.rat.anttasks.Copyright
-
Deprecated.
- build() - Method in class org.apache.rat.anttasks.Family
-
Deprecated.
- build() - Method in class org.apache.rat.anttasks.Not
-
Deprecated.
- build() - Method in class org.apache.rat.anttasks.Regex
-
Deprecated.
- build() - Method in class org.apache.rat.anttasks.Spdx
-
Deprecated.
- build() - Method in class org.apache.rat.anttasks.Text
-
Deprecated.
- build(SortedSet<ILicenseFamily>) - Method in class org.apache.rat.anttasks.License
-
Deprecated.
C
- Cntr() - Constructor for class org.apache.rat.anttasks.BaseAntTask.Cntr
- Copyright - Class in org.apache.rat.anttasks
-
Deprecated.use configuration file.
- Copyright() - Constructor for class org.apache.rat.anttasks.Copyright
-
Deprecated.
- createConfig() - Method in class org.apache.rat.anttasks.BaseAntTask
-
File names for system configuration.
- createCounterMax() - Method in class org.apache.rat.anttasks.BaseAntTask
-
The acceptable maximum number for the specified counter.
- createCounterMin() - Method in class org.apache.rat.anttasks.BaseAntTask
-
The minimum number for the specified counter.
- createExclude() - Method in class org.apache.rat.anttasks.BaseAntTask
-
Deprecated.Deprecated for removal since 0.17: Use <inputExclude> instead.
- createInclude() - Method in class org.apache.rat.anttasks.BaseAntTask
-
Deprecated.Deprecated for removal since 0.17: Use <inputInclude> instead.
- createInputExclude() - Method in class org.apache.rat.anttasks.BaseAntTask
-
Excludes files matching <Expression>.
- createInputExcludeParsedScm() - Method in class org.apache.rat.anttasks.BaseAntTask
-
Parse SCM based exclusion files to exclude specified files and directories.
- createInputInclude() - Method in class org.apache.rat.anttasks.BaseAntTask
-
Includes files matching <Expression>.
- createLicenseFamiliesApproved() - Method in class org.apache.rat.anttasks.BaseAntTask
-
A comma separated list of approved license family IDs.
- createLicenseFamiliesDenied() - Method in class org.apache.rat.anttasks.BaseAntTask
-
A comma separated list of denied License family IDs.
- createLicenses() - Method in class org.apache.rat.anttasks.BaseAntTask
-
Deprecated.Deprecated for removal since 0.17: Use <config> instead.
- createLicensesApproved() - Method in class org.apache.rat.anttasks.BaseAntTask
-
A comma separated list of approved License IDs.
- createLicensesDenied() - Method in class org.apache.rat.anttasks.BaseAntTask
-
A comma separated list of denied License IDs.
- createName(String) - Static method in class org.apache.rat.anttasks.BaseAntTask
E
- execute() - Method in class org.apache.rat.anttasks.Help
-
Generates the help.
- execute() - Method in class org.apache.rat.anttasks.Report
-
Generates the report.
- Expr() - Constructor for class org.apache.rat.anttasks.BaseAntTask.Expr
F
- Family - Class in org.apache.rat.anttasks
-
Deprecated.use configuration file.
- Family() - Constructor for class org.apache.rat.anttasks.Family
-
Deprecated.
- Filename() - Constructor for class org.apache.rat.anttasks.BaseAntTask.Filename
- fromProjectLevel(int) - Static method in class org.apache.rat.anttasks.Report
-
Converts to RAT log level from Ant Project log level.
G
- getArg(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Get the list of values for a key.
- getConfiguration() - Method in class org.apache.rat.anttasks.Report
-
Creates the ReportConfiguration from the ant options.
- getNative() - Method in class org.apache.rat.anttasks.Report.AddLicenseHeaders
-
Deprecated.
- getOptionComparator() - Method in class org.apache.rat.anttasks.Help.AntHelpFormatter
- getValues() - Method in class org.apache.rat.anttasks.Report.AddLicenseHeaders
-
Deprecated.
- getValues() - Method in class org.apache.rat.anttasks.Report.ApprovalFilter
-
Deprecated.
- getValues(Arg) - Method in class org.apache.rat.anttasks.Report
-
Reads values for the Arg.
H
- Help - Class in org.apache.rat.anttasks
-
A basic Ant task that generates a report on all files specified by the nested resource collection(s).
- Help() - Constructor for class org.apache.rat.anttasks.Help
-
Constructor.
- Help.AntHelpFormatter - Class in org.apache.rat.anttasks
I
- internalFilter() - Method in class org.apache.rat.anttasks.Report.ApprovalFilter
-
Deprecated.
L
- License - Class in org.apache.rat.anttasks
-
Deprecated.use configuration file.
- License() - Constructor for class org.apache.rat.anttasks.License
-
Deprecated.
- log(String, int) - Method in class org.apache.rat.anttasks.Help
- log(String, int) - Method in class org.apache.rat.anttasks.Report
- log(String, Throwable, int) - Method in class org.apache.rat.anttasks.Help
- log(String, Throwable, int) - Method in class org.apache.rat.anttasks.Report
- Lst() - Constructor for class org.apache.rat.anttasks.BaseAntTask.Lst
N
- Not - Class in org.apache.rat.anttasks
-
Deprecated.use configuration file.
- Not() - Constructor for class org.apache.rat.anttasks.Not
-
Deprecated.
O
- org.apache.rat.anttasks - package org.apache.rat.anttasks
-
The base package for the RAT Apache Ant Task Library.
R
- Regex - Class in org.apache.rat.anttasks
-
Deprecated.use configuration file.
- Regex() - Constructor for class org.apache.rat.anttasks.Regex
-
Deprecated.
- removeArg(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Remove a key from the argument list.
- removeKey(Arg) - Method in class org.apache.rat.anttasks.Report
-
Removes the values for the arg.
- renderOptions(StringBuffer, int, Options, int, int) - Method in class org.apache.rat.anttasks.Help.AntHelpFormatter
- Report - Class in org.apache.rat.anttasks
-
A basic Ant task that generates a report on all files specified by the nested resource collection(s).
- Report() - Constructor for class org.apache.rat.anttasks.Report
-
Constructor.
- Report.AddLicenseHeaders - Class in org.apache.rat.anttasks
-
Deprecated.use <editCopyright> amd <editOverwrite> instead.
- Report.ApprovalFilter - Class in org.apache.rat.anttasks
-
Deprecated.use listLicenses or listFamilies attributes.
S
- setAddApprovedLicense(String) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.use licensesApproved child element.
- setAddDefaultDefinitions(File) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.Use Config child element
- setAddLicense(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Deprecated.Deprecated for removal since 0.17: Use editLicense attribute instead.
- setAddLicenseHeaders(Report.AddLicenseHeaders) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.use editLicense and editOverwrite attributes
- setArg(String, String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Set a key and value into the argument list.
- setConfigurationNoDefaults(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Ignore default configuration.
- setCopyright(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Deprecated.Deprecated for removal since 0.17: Use editCopyright attribute instead.
- setCopyrightMessage(String) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.use copyright attribute
- setDryRun(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask
-
If set do not update the files but generate the reports.
- setEditCopyright(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
The copyright message to use in the license headers.
- setEditLicense(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Add the default license header to any file with an unknown license that is not in the exclusion list.
- setEditOverwrite(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Forces any changes in files to be written directly to the source files so that new files are not created.
- setEnd(String) - Method in class org.apache.rat.anttasks.Copyright
-
Deprecated.
- setExcludeFile(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Deprecated.Deprecated for removal since 0.17: Use inputExcludeFile attribute instead.
- setExpr(String) - Method in class org.apache.rat.anttasks.Regex
-
Deprecated.
- setFamily(String) - Method in class org.apache.rat.anttasks.License
-
Deprecated.
- setForce(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Deprecated.Deprecated for removal since 0.17: Use editOverwrite attribute instead.
- setFormat(String) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.
- setHelpLicenses(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Print information about registered licenses.
- setId(String) - Method in class org.apache.rat.anttasks.Family
-
Deprecated.
- setId(String) - Method in class org.apache.rat.anttasks.License
-
Deprecated.
- setIncludesFile(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Deprecated.Deprecated for removal since 0.17: Use inputIncludeFile attribute instead.
- setInputExcludeSize(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Excludes files with sizes less than the given argument.
- setInputFileFilter(IOFileFilter) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.
- setLicenses(File) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.create a configuration file and use the <config> child element.
- setListFamilies(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Deprecated.Deprecated for removal since 0.17: Use outputFamilies attribute instead.
- setListLicenses(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Deprecated.Deprecated for removal since 0.17: Use outputLicenses attribute instead.
- setName(String) - Method in class org.apache.rat.anttasks.Family
-
Deprecated.
- setName(String) - Method in class org.apache.rat.anttasks.License
-
Deprecated.
- setName(String) - Method in class org.apache.rat.anttasks.Spdx
-
Deprecated.
- setNoDefaultLicenses(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Deprecated.Deprecated for removal since 0.17: Use configurationNoDefaults attribute instead.
- setNotes(String) - Method in class org.apache.rat.anttasks.License
-
Deprecated.
- setOut(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Deprecated.Deprecated for removal since 0.17: Use outputFile attribute instead.
- setOutputArchive(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Specifies the level of detail in ARCHIVE file reporting.
- setOutputFamilies(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
List the defined license families.
- setOutputFile(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Define the output file where to write a report to.
- setOutputLicenses(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
List the defined licenses.
- setOutputStandard(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Specifies the level of detail in STANDARD file reporting.
- setOutputStyle(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
XSLT stylesheet to use when creating the report.
- setOwner(String) - Method in class org.apache.rat.anttasks.Copyright
-
Deprecated.
- setRemoveApprovedLicense(String) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.use licensesFamiliesDenied child element
- setRemoveApprovedLicense(String[]) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.use licenseFamiliesDenied element
- setReportFile(File) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.use outputFile element
- setScanHiddenDirectories(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Deprecated.Deprecated for removal since 0.17: Use <inputIncludeStd> with 'HIDDEN_DIR' argument instead.
- setStart(String) - Method in class org.apache.rat.anttasks.Copyright
-
Deprecated.
- setStyleReport(boolean) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.use
BaseAntTask.setOutputStyle(String)
and pass "xml" or "plain-rat". - setStylesheet(String) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Deprecated.Deprecated for removal since 0.17: Use outputStyle attribute instead.
- setText(String) - Method in class org.apache.rat.anttasks.Text
-
Deprecated.
- setUseDefaultLicenses(boolean) - Method in class org.apache.rat.anttasks.Report
-
Deprecated.use noDefaultLicenses attribute
- setXml(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask
-
Deprecated.Deprecated for removal since 0.17: Use outputStyle attribute with the 'xml' argument instead.
- Spdx - Class in org.apache.rat.anttasks
-
Deprecated.use configuration file.
- Spdx() - Constructor for class org.apache.rat.anttasks.Spdx
-
Deprecated.
- Std() - Constructor for class org.apache.rat.anttasks.BaseAntTask.Std
T
- Text - Class in org.apache.rat.anttasks
-
Deprecated.use configuration file.
- Text() - Constructor for class org.apache.rat.anttasks.Text
-
Deprecated.
- TxtValue() - Constructor for class org.apache.rat.anttasks.BaseAntTask.TxtValue
U
- unsupportedArgs() - Static method in class org.apache.rat.anttasks.BaseAntTask
V
- validate(ReportConfiguration) - Method in class org.apache.rat.anttasks.Report
-
validates the task's configuration.
- value - Variable in class org.apache.rat.anttasks.BaseAntTask.TxtValue
All Classes and Interfaces|All Packages