org.apache.maven.plugins.checkstyle.exec

Class DefaultCheckstyleExecutor

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor

All Implemented Interfaces:

CheckstyleExecutor, org.codehaus.plexus.logging.LogEnabled

@Component(role=CheckstyleExecutor.class,
           hint="default",
           instantiationStrategy="per-lookup")
public class DefaultCheckstyleExecutor
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements CheckstyleExecutor

Since:

2.5

Author:

Olivier Lamy

Constructor Summary

Constructors

Constructor and Description
DefaultCheckstyleExecutor()

Method Summary

Modifier and Type	Method and Description
protected void	addSourceDirectory(CheckstyleCheckerListener sinkListener, Collection<File> sourceDirectories, Collection<File> testSourceDirectories, List<org.apache.maven.model.Resource> resources, CheckstyleExecutorRequest request)
CheckstyleResults	executeCheckstyle(CheckstyleExecutorRequest request)
com.puppycrawl.tools.checkstyle.api.Configuration	getConfiguration(CheckstyleExecutorRequest request)

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCheckstyleExecutor

public DefaultCheckstyleExecutor()

Method Detail

executeCheckstyle

public CheckstyleResults executeCheckstyle(CheckstyleExecutorRequest request)
                                    throws CheckstyleExecutorException,
                                           com.puppycrawl.tools.checkstyle.api.CheckstyleException

Specified by:

executeCheckstyle in interface CheckstyleExecutor

Parameters:

request - CheckstyleExecutorRequest

Returns:

CheckstyleResults

Throws:

CheckstyleExecutorException - in case of an error during plugin execution.

com.puppycrawl.tools.checkstyle.api.CheckstyleException - in case of an error raised by Checkstyle.

addSourceDirectory

protected void addSourceDirectory(CheckstyleCheckerListener sinkListener,
                                  Collection<File> sourceDirectories,
                                  Collection<File> testSourceDirectories,
                                  List<org.apache.maven.model.Resource> resources,
                                  CheckstyleExecutorRequest request)

getConfiguration

public com.puppycrawl.tools.checkstyle.api.Configuration getConfiguration(CheckstyleExecutorRequest request)
                                                                   throws CheckstyleExecutorException

Specified by:

getConfiguration in interface CheckstyleExecutor

Throws:

CheckstyleExecutorException