Package org.apache.maven.plugins.checkstyle

Class CheckstyleViolationCheckMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo

All Implemented Interfaces:

ContextEnabled, Mojo

@Mojo(name="check",
      defaultPhase=VERIFY,
      requiresDependencyResolution=NONE,
      threadSafe=true)
public class CheckstyleViolationCheckMojo
extends AbstractMojo

Performs Checkstyle analysis and outputs violations or a count of violations to the console, potentially failing the build. It can also be configured to re-use an earlier analysis.

Author:

Joakim Erdfelt

Field Summary

Fields

Modifier and Type	Field	Description
protected CheckstyleExecutor	checkstyleExecutor
protected MavenProject	project	The Maven Project Object.
protected java.util.List<Resource>	resources	Specifies the location of the resources to be used for Checkstyle.
protected java.util.List<Resource>	testResources	Specifies the location of the test resources to be used for Checkstyle.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
CheckstyleViolationCheckMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()

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

Field Detail

resources

@Parameter(defaultValue="${project.resources}",
           readonly=true)
protected java.util.List<Resource> resources

Specifies the location of the resources to be used for Checkstyle.

Since:

2.11

testResources

@Parameter(defaultValue="${project.testResources}",
           readonly=true)
protected java.util.List<Resource> testResources

Specifies the location of the test resources to be used for Checkstyle.

Since:

2.16

checkstyleExecutor

@Component(role=CheckstyleExecutor.class,
           hint="default")
protected CheckstyleExecutor checkstyleExecutor

Since:

2.5

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected MavenProject project

The Maven Project Object.

Constructor Detail

CheckstyleViolationCheckMojo

public CheckstyleViolationCheckMojo()

Method Detail

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Throws:

MojoExecutionException

MojoFailureException