org.codehaus.mojo.codenarc.CodeNarcMojo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of codenarc-maven-plugin Show documentation
Show all versions of codenarc-maven-plugin Show documentation
This Plug-In generates reports based on the CodeNarc Analyzer
The newest version!
//
// Generated stub from file:/Users/garvin/gitProjects/codenarc-maven-plugin/target/checkout/src/main/groovy/org/codehaus/mojo/codenarc/CodeNarcMojo.groovy
//
package org.codehaus.mojo.codenarc;
import java.lang.*;
import java.io.*;
import java.net.*;
import java.util.*;
import groovy.lang.*;
import groovy.util.*;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.List;
import org.apache.maven.reporting.AbstractMavenReport;
import org.apache.maven.project.MavenProject;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.factory.ArtifactFactory;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.artifact.resolver.ArtifactResolver;
import org.apache.maven.doxia.siterenderer.Renderer;
import org.apache.maven.doxia.tools.SiteTool;
import org.apache.maven.plugin.MojoFailureException;
import org.codehaus.plexus.resource.ResourceManager;
import org.codehaus.plexus.resource.loader.FileResourceLoader;
/**
* Create a CodeNarc Report.
*
* @goal codenarc
* @phase site
* @requiresDependencyResolution compile
* @requiresProject
* @author Garvin LeClaire
* @version $Id: CodeNarcMojo.groovy gleclaire $
*/
public class CodeNarcMojo
extends AbstractMavenReport
implements groovy.lang.GroovyObject
{
/**
* The name of the Plug-In.
*/
static final private java.lang.String PLUGIN_NAME = null;
static final public java.lang.String getPLUGIN_NAME() {
throw new InternalError("Stubbed method");
}
/**
* The name of the property resource bundle (Filesystem).
*/
static final private java.lang.String BUNDLE_NAME = null;
static final public java.lang.String getBUNDLE_NAME() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the name of the Plug-In from the bundle.
*/
static final private java.lang.String NAME_KEY = null;
static final public java.lang.String getNAME_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the description of the Plug-In from the bundle.
*/
static final private java.lang.String DESCRIPTION_KEY = null;
static final public java.lang.String getDESCRIPTION_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The handle for the resource bundle.
*/
private ResourceBundle bundle = null;
public ResourceBundle getBundle() {
throw new InternalError("Stubbed method");
}
public void setBundle(ResourceBundle value) {
throw new InternalError("Stubbed method");
}
/**
* Maven Project
*
* @parameter expression="${project}"
* @required
* @readonly
*/
private MavenProject project = null;
public void setProject(MavenProject value) {
throw new InternalError("Stubbed method");
}
/**
* Location where generated html will be created.
*
* @parameter default-value="${project.reporting.outputDirectory}"
* @required
*/
private File outputDirectory = null;
public void setOutputDirectory(File value) {
throw new InternalError("Stubbed method");
}
/**
* Specifies the directory where the xml output will be generated.
*
* @parameter default-value="${project.build.directory}"
* @required
*/
private File xmlOutputDirectory = null;
public File getXmlOutputDirectory() {
throw new InternalError("Stubbed method");
}
public void setXmlOutputDirectory(File value) {
throw new InternalError("Stubbed method");
}
/**
* Doxia Site Renderer.
*
* @component
* @required
* @readonly
*/
private Renderer siteRenderer = null;
public void setSiteRenderer(Renderer value) {
throw new InternalError("Stubbed method");
}
/**
* SiteTool.
*
* @component role="org.apache.maven.doxia.tools.SiteTool"
* @required
* @readonly
*/
protected SiteTool siteTool = null;
/**
* @component
* @required
* @readonly
*/
private ResourceManager resourceManager = null;
public ResourceManager getResourceManager() {
throw new InternalError("Stubbed method");
}
public void setResourceManager(ResourceManager value) {
throw new InternalError("Stubbed method");
}
/**
* Skip entire check.
*
* @parameter expression="${codenarc.skip}" default-value="false"
*/
private boolean skip = false;
public boolean getSkip() {
throw new InternalError("Stubbed method");
}
public boolean isSkip() {
throw new InternalError("Stubbed method");
}
public void setSkip(boolean value) {
throw new InternalError("Stubbed method");
}
/**
* Maximum Java heap size in megabytes (default=512).
*
* @parameter expression="${codenarc.maxHeap}" default-value="512"
*/
private int maxHeap = 0;
public int getMaxHeap() {
throw new InternalError("Stubbed method");
}
public void setMaxHeap(int value) {
throw new InternalError("Stubbed method");
}
/**
* The CodeNarc rulesets to use. See the CodeNarc Rule Index
* for a list of some included. Defaults to the "rulesets/basic.xml,rulesets/exceptions.xml,rulesets/imports.xml"
*
* @parameter expression="${codenarc.rulesetfiles}"
*/
private java.lang.String rulesetfiles = null;
public java.lang.String getRulesetfiles() {
throw new InternalError("Stubbed method");
}
public void setRulesetfiles(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* The comma-separated list of Ant-style file patterns specifying files that must be included.
* See the CodeNarc Command-Line Parameters
* for the default behavior.
*
* @parameter expression="${codenarc.includes}"
*/
private java.lang.String includes = null;
public java.lang.String getIncludes() {
throw new InternalError("Stubbed method");
}
public void setIncludes(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* The comma-separated list of Ant-style file patterns specifying files that must be excluded.
* See the CodeNarc Command-Line Parameters
* for the default behavior.
*
* @parameter expression="${codenarc.excludes}"
*/
private java.lang.String excludes = null;
public java.lang.String getExcludes() {
throw new InternalError("Stubbed method");
}
public void setExcludes(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* The CodeNarc log4j config file.
* Each path may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:"
* (to load from a relative or absolute filesystem path), or "http:".
*
* @parameter expression="${codenarc.log4jConfigFile}"
*/
private java.lang.String log4jConfigFile = null;
public java.lang.String getLog4jConfigFile() {
throw new InternalError("Stubbed method");
}
public void setLog4jConfigFile(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* Specifies the location of the source directory to be used for CodeNarc.
*
* @parameter default-value="${project.build.sourceDirectory}"
* @required
*/
private File sourceDirectory = null;
public File getSourceDirectory() {
throw new InternalError("Stubbed method");
}
public void setSourceDirectory(File value) {
throw new InternalError("Stubbed method");
}
/**
* The directories containing the sources to be compiled.
*
* @parameter expression="${project.compileSourceRoots}"
* @required
* @readonly
* @since 0.18.1-1
*/
private List compileSourceRoots = null;
public List getCompileSourceRoots() {
throw new InternalError("Stubbed method");
}
public void setCompileSourceRoots(List value) {
throw new InternalError("Stubbed method");
}
/**
* The directories containing the test-sources to be compiled.
*
* @parameter expression="${project.testCompileSourceRoots}"
* @required
* @readonly
* @since 0.18.1-1
*/
private List testSourceRoots = null;
public List getTestSourceRoots() {
throw new InternalError("Stubbed method");
}
public void setTestSourceRoots(List value) {
throw new InternalError("Stubbed method");
}
/**
* Used to look up Artifacts in the remote repository.
*
* @parameter expression="${component.org.apache.maven.artifact.factory.ArtifactFactory}"
* @required
* @readonly
*/
protected ArtifactFactory factory = null;
/**
* Used to look up Artifacts in the remote repository.
*
* @parameter expression="${component.org.apache.maven.artifact.resolver.ArtifactResolver}"
* @required
* @readonly
*/
protected ArtifactResolver artifactResolver = null;
/**
* List of Remote Repositories used by the resolver
*
* @parameter expression="${project.remoteArtifactRepositories}"
* @readonly
* @required
*/
protected List remoteRepositories = null;
/**
* Location of the local repository.
*
* @parameter expression="${localRepository}"
* @readonly
* @required
*/
protected ArtifactRepository localRepository = null;
/**
* The maximum number of priority 1 violations allowed before
* failing the build.
*
* @parameter expression="${codenarc.maxPriority1Violations}" default-value = "-1"
* @since 0.17-2
*/
private int maxPriority1Violations = 0;
public int getMaxPriority1Violations() {
throw new InternalError("Stubbed method");
}
public void setMaxPriority1Violations(int value) {
throw new InternalError("Stubbed method");
}
/**
* The maximum number of priority 2 violations allowed before
* failing the build.
*
* @parameter expression="${codenarc.maxPriority2Violations}" default-value = "-1"
* @since 0.17-2
*/
private int maxPriority2Violations = 0;
public int getMaxPriority2Violations() {
throw new InternalError("Stubbed method");
}
public void setMaxPriority2Violations(int value) {
throw new InternalError("Stubbed method");
}
/**
* The maximum number of priority 3 violations allowed before
* failing the build.
*
* @parameter expression="${codenarc.maxPriority3Violations}" default-value = "-1"
* @since 0.17-2
*/
private int maxPriority3Violations = 0;
public int getMaxPriority3Violations() {
throw new InternalError("Stubbed method");
}
public void setMaxPriority3Violations(int value) {
throw new InternalError("Stubbed method");
}
/**
* Default log4j file content if one dosn't exist.
*/
private java.lang.Object log4jContents = null;
public java.lang.Object getLog4jContents() {
throw new InternalError("Stubbed method");
}
public void setLog4jContents(java.lang.Object value) {
throw new InternalError("Stubbed method");
}
/**
* The CodeNarc version to use for the plugin
*
* @parameter expression="${codenarc.codenarc.version}" default-value="0.22"
*/
private java.lang.String codeNarcVersion = null;
public java.lang.String getCodeNarcVersion() {
throw new InternalError("Stubbed method");
}
public void setCodeNarcVersion(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* The log4j version to use for the plugin
*
* @parameter expression="${codenarc.log4j.version}" default-value="1.2.13"
*/
private java.lang.String log4jVersion = null;
public java.lang.String getLog4jVersion() {
throw new InternalError("Stubbed method");
}
public void setLog4jVersion(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* The Groovy version to use for the plugin
*
* @parameter expression="${codenarc.groovy.version}" default-value="1.7.5"
*/
private java.lang.String groovyVersion = null;
public java.lang.String getGroovyVersion() {
throw new InternalError("Stubbed method");
}
public void setGroovyVersion(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* Executes the generation of the report.
*
* Callback from Maven Site Plugin or from AbstractMavenReport.execute() => generate().
*
* @param locale
the locale the report should be generated for
* @see org.apache.maven.reporting.AbstractMavenReport #executeReport(java.util.Locale)
*/
protected void executeReport(Locale locale) {
throw new InternalError("Stubbed method");
}
/**
* Checks whether prerequisites for generating this report are given.
*
* @return true if report can be generated, otherwise false
* @see org.apache.maven.reporting.MavenReport#canGenerateReport()
*/
public boolean canGenerateReport() {
throw new InternalError("Stubbed method");
}
/**
* Returns the plugins description for the "generated reports" overview page.
*
* @param locale
the locale the report should be generated for
* @return description of the report
* @see org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)
*/
public java.lang.String getDescription(Locale locale) {
throw new InternalError("Stubbed method");
}
/**
* Returns the plugins name for the "generated reports" overview page and the menu.
*
* @param locale
the locale the report should be generated for
* @return name of the report
* @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
*/
public java.lang.String getName(Locale locale) {
throw new InternalError("Stubbed method");
}
/**
* Returns report output file name, without the extension.
*
* Called by AbstractMavenReport.execute() for creating the sink.
*
* @return name of the generated page
* @see org.apache.maven.reporting.MavenReport#getOutputName()
*/
public java.lang.String getOutputName() {
throw new InternalError("Stubbed method");
}
protected MavenProject getProject() {
throw new InternalError("Stubbed method");
}
/**
* Returns the report output directory.
*
* Called by AbstractMavenReport.execute() for creating the sink.
*
* @return full path to the directory where the files in the site get copied to
* @see org.apache.maven.reporting.AbstractMavenReport#getOutputDirectory()
*/
protected java.lang.String getOutputDirectory() {
throw new InternalError("Stubbed method");
}
protected Renderer getSiteRenderer() {
throw new InternalError("Stubbed method");
}
public ResourceBundle getBundle(java.lang.Object locale) {
throw new InternalError("Stubbed method");
}
protected java.lang.String cleanPath(File filePathToClean) {
throw new InternalError("Stubbed method");
}
protected java.lang.String cleanPath(java.lang.String pathToClean) {
throw new InternalError("Stubbed method");
}
public groovy.lang.MetaClass getMetaClass() {
throw new InternalError("Stubbed method");
}
public void setMetaClass(groovy.lang.MetaClass metaClass) {
throw new InternalError("Stubbed method");
}
public java.lang.Object invokeMethod(java.lang.String name, java.lang.Object args) {
throw new InternalError("Stubbed method");
}
public java.lang.Object getProperty(java.lang.String name) {
throw new InternalError("Stubbed method");
}
public void setProperty(java.lang.String name, java.lang.Object value) {
throw new InternalError("Stubbed method");
}
}