|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.codehaus.mojo.rat.AbstractRatMojo
public abstract class AbstractRatMojo
Abstract base class for Mojos, which are running RAT.
Field Summary | |
---|---|
protected java.io.File |
basedir
The base directory, in which to search for files. |
static java.lang.String[] |
ECLIPSE_DEFAULT_EXCLUDES
The Eclipse specific default excludes. |
static java.lang.String[] |
IDEA_DEFAULT_EXCLUDES
The IDEA specific default excludes. |
static java.lang.String[] |
MAVEN_DEFAULT_EXCLUDES
The Maven specific default excludes. |
Fields inherited from interface org.apache.maven.plugin.Mojo |
---|
ROLE |
Constructor Summary | |
---|---|
AbstractRatMojo()
|
Method Summary | |
---|---|
protected void |
createReport(java.io.PrintWriter out,
java.io.InputStream style)
Writes the report to the given stream. |
protected rat.analysis.IHeaderMatcher[] |
getLicenseMatchers()
Returns the set of header matchers to use. |
protected org.apache.maven.project.MavenProject |
getProject()
Returns the Maven project. |
protected rat.report.IReportable |
getResources()
Creates an iterator over the files to check. |
Methods inherited from class org.apache.maven.plugin.AbstractMojo |
---|
getLog, getPluginContext, setLog, setPluginContext |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.maven.plugin.Mojo |
---|
execute |
Field Detail |
---|
public static final java.lang.String[] MAVEN_DEFAULT_EXCLUDES
public static final java.lang.String[] ECLIPSE_DEFAULT_EXCLUDES
public static final java.lang.String[] IDEA_DEFAULT_EXCLUDES
protected java.io.File basedir
Constructor Detail |
---|
public AbstractRatMojo()
Method Detail |
---|
protected org.apache.maven.project.MavenProject getProject()
protected rat.analysis.IHeaderMatcher[] getLicenseMatchers() throws org.apache.maven.plugin.MojoFailureException, org.apache.maven.plugin.MojoExecutionException
header matchers
to use.
org.apache.maven.plugin.MojoFailureException
- An error in the plugin configuration was detected.
org.apache.maven.plugin.MojoExecutionException
- An error occurred while calculating the result.protected rat.report.IReportable getResources()
protected void createReport(java.io.PrintWriter out, java.io.InputStream style) throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
out
- The target writer, to which the report is being written.style
- The stylesheet to use
org.apache.maven.plugin.MojoFailureException
- An error in the plugin configuration was detected.
org.apache.maven.plugin.MojoExecutionException
- Another error occurred while creating the report.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |