Note:This goal should be used as a Maven report.
Full name:
org.apache.rat:apache-rat-plugin:0.15:rat
Description:
Attributes:
test
.Name | Type | Since | Description |
---|---|---|---|
<basedir> |
File |
- |
The base directory, in which to search for files. Default value is: ${basedir} .User property is: rat.basedir . |
Name | Type | Since | Description |
---|---|---|---|
<addDefaultLicenseMatchers> |
boolean |
- |
Whether to add the default list of license matchers. Default value is: true .User property is: rat.addDefaultLicenseMatchers . |
<excludeSubProjects> |
boolean |
- |
Whether to exclude subprojects. This is recommended, if you want a
separate apache-rat-plugin report for each subproject. Default value is: true .User property is: rat.excludeSubprojects . |
<excludes> |
String[] |
- |
Specifies files, which are excluded in the report. By default, no
files are excluded. |
<excludesFile> |
String |
- |
Specifies a file, from which to read excludes. Basically, an
alternative to specifying the excludes as a list. The excludesFile
is assumed to be using the UFT8 character set. User property is: rat.excludesFile . |
<excludesFileCharset> |
String |
- |
Specifies the include files character set. Defaults to
@code{${project.build.sourceEncoding}), or @code{UTF8}. Default value is: ${project.build.sourceEncoding} .User property is: rat.excludesFileCharset . |
<includes> |
String[] |
- |
Specifies files, which are included in the report. By default, all
files are included. |
<includesFile> |
String |
- |
Specifies a file, from which to read includes. Basically, an
alternative to specifying the includes as a list. User property is: rat.includesFile . |
<includesFileCharset> |
String |
- |
Specifies the include files character set. Defaults to
@code{${project.build.sourceEncoding}), or @code{UTF8}. Default value is: ${project.build.sourceEncoding} .User property is: rat.includesFileCharset . |
<licenseFamilies> |
ILicenseFamily[] |
0.8 |
Specifies the license families to accept. |
<licenseMatchers> |
HeaderMatcherSpecification[] |
- |
Deprecated. Use licenses instead. |
<licenses> |
IHeaderMatcher[] |
0.8 |
Specifies the licenses to accept. By default, these are added to
the default licenses, unless you set
addDefaultLicenseMatchers to false. |
<parseSCMIgnoresAsExcludes> |
boolean |
- |
Whether to parse source code management system (SCM) ignore files
and use their contents as excludes. At the moment this works for
the following SCMs: Default value is: true .User property is: rat.parseSCMIgnoresAsExcludes . |
<skip> |
boolean |
0.11 |
Will skip the plugin execution, e.g. for technical builds that do
not take license compliance into account. Default value is: false .User property is: rat.skip . |
<useDefaultExcludes> |
boolean |
- |
Whether to use the default excludes when scanning for files. The
default excludes are:
Default value is: true .User property is: rat.useDefaultExcludes . |
<useEclipseDefaultExcludes> |
boolean |
- |
Whether to use the Eclipse specific default excludes when scanning
for files. Eclipse specific default excludes are given by the
constant ECLIPSE_DEFAULT_EXCLUDES: The .classpath and
.project files, the .settings directory,
and so on.Default value is: true .User property is: rat.useEclipseDefaultExcludes . |
<useIdeaDefaultExcludes> |
boolean |
- |
Whether to use the IDEA specific default excludes when scanning for
files. IDEA specific default excludes are given by the constant
IDEA_DEFAULT_EXCLUDES: The *.iml , *.ipr
and *.iws files and the .idea directory.Default value is: true .User property is: rat.useIdeaDefaultExcludes . |
<useMavenDefaultExcludes> |
boolean |
- |
Whether to use the Maven specific default excludes when scanning
for files. Maven specific default excludes are given by the
constant MAVEN_DEFAULT_EXCLUDES: The target directory,
the cobertura.ser file, and so on.Default value is: true .User property is: rat.useMavenDefaultExcludes . |
boolean
No
rat.addDefaultLicenseMatchers
true
java.io.File
Yes
rat.basedir
${basedir}
boolean
No
rat.excludeSubprojects
true
java.lang.String[]
No
java.lang.String
No
rat.excludesFile
java.lang.String
No
rat.excludesFileCharset
${project.build.sourceEncoding}
java.lang.String[]
No
java.lang.String
No
rat.includesFile
java.lang.String
No
rat.includesFileCharset
${project.build.sourceEncoding}
org.apache.rat.license.ILicenseFamily[]
0.8
No
licenses
instead.licenses
instead.org.apache.rat.mp.HeaderMatcherSpecification[]
No
addDefaultLicenseMatchers
to false.org.apache.rat.analysis.IHeaderMatcher[]
0.8
No
boolean
No
rat.parseSCMIgnoresAsExcludes
true
boolean
0.11
No
rat.skip
false
SourceCodeManagementSystems
boolean
No
rat.useDefaultExcludes
true
.classpath
and
.project
files, the .settings
directory,
and so on.boolean
No
rat.useEclipseDefaultExcludes
true
*.iml
, *.ipr
and *.iws
files and the .idea
directory.boolean
No
rat.useIdeaDefaultExcludes
true
target
directory,
the cobertura.ser
file, and so on.boolean
No
rat.useMavenDefaultExcludes
true