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
-
-
Field Summary
Fields Modifier and Type Field Description private org.codehaus.plexus.resource.ResourceManager
licenseLocator
private org.codehaus.plexus.resource.ResourceManager
locator
-
Constructor Summary
Constructors Constructor Description DefaultCheckstyleExecutor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
addAttributeIfNotExists(com.puppycrawl.tools.checkstyle.DefaultConfiguration config, java.lang.String name, java.lang.String value)
private void
addFilesToProcess(CheckstyleExecutorRequest request, java.util.Collection<java.io.File> sourceDirectories, java.util.List<org.apache.maven.model.Resource> resources, java.util.List<org.apache.maven.model.Resource> testResources, java.util.Collection<java.io.File> files, java.util.Collection<java.io.File> testSourceDirectories)
private void
addResourceFilesToProcess(CheckstyleExecutorRequest request, java.util.List<org.apache.maven.model.Resource> resources, java.util.Collection<java.io.File> files)
protected void
addSourceDirectory(CheckstyleCheckerListener sinkListener, java.util.Collection<java.io.File> sourceDirectories, java.util.Collection<java.io.File> testSourceDirectories, java.util.List<org.apache.maven.model.Resource> resources, CheckstyleExecutorRequest request)
private boolean
anyDirectoryExists(java.util.Collection<java.io.File> files)
private void
configureResourceLocator(org.codehaus.plexus.resource.ResourceManager resourceManager, CheckstyleExecutorRequest request, java.util.List<org.apache.maven.artifact.Artifact> additionalArtifacts)
Configures search paths in the resource locator.CheckstyleResults
executeCheckstyle(CheckstyleExecutorRequest request)
private java.lang.String
getCheckstyleVersion()
Get the effective Checkstyle version at runtime.private java.lang.String
getConfigFile(CheckstyleExecutorRequest request)
com.puppycrawl.tools.checkstyle.api.Configuration
getConfiguration(CheckstyleExecutorRequest request)
private java.util.List<java.io.File>
getFilesToProcess(CheckstyleExecutorRequest request)
private java.util.Properties
getOverridingProperties(CheckstyleExecutorRequest request)
private java.lang.String
getSuppressionsFilePath(CheckstyleExecutorRequest request)
private com.puppycrawl.tools.checkstyle.api.FilterSet
getSuppressionsFilterSet(java.lang.String suppressionsFilePath)
private void
prepareCheckstylePaths(CheckstyleExecutorRequest request, org.apache.maven.project.MavenProject project, java.util.List<java.lang.String> classPathStrings, java.util.List<java.lang.String> outputDirectories, java.util.Collection<java.io.File> sourceDirectories, java.util.Collection<java.io.File> testSourceDirectories)
-
-
-
Method Detail
-
executeCheckstyle
public CheckstyleResults executeCheckstyle(CheckstyleExecutorRequest request) throws CheckstyleExecutorException, com.puppycrawl.tools.checkstyle.api.CheckstyleException
- Specified by:
executeCheckstyle
in interfaceCheckstyleExecutor
- 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, java.util.Collection<java.io.File> sourceDirectories, java.util.Collection<java.io.File> testSourceDirectories, java.util.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 interfaceCheckstyleExecutor
- Throws:
CheckstyleExecutorException
-
addAttributeIfNotExists
private void addAttributeIfNotExists(com.puppycrawl.tools.checkstyle.DefaultConfiguration config, java.lang.String name, java.lang.String value)
-
prepareCheckstylePaths
private void prepareCheckstylePaths(CheckstyleExecutorRequest request, org.apache.maven.project.MavenProject project, java.util.List<java.lang.String> classPathStrings, java.util.List<java.lang.String> outputDirectories, java.util.Collection<java.io.File> sourceDirectories, java.util.Collection<java.io.File> testSourceDirectories) throws CheckstyleExecutorException
- Throws:
CheckstyleExecutorException
-
anyDirectoryExists
private boolean anyDirectoryExists(java.util.Collection<java.io.File> files)
-
getCheckstyleVersion
private java.lang.String getCheckstyleVersion()
Get the effective Checkstyle version at runtime.- Returns:
- the MANIFEST implementation version of Checkstyle API package (can be
null
)
-
getOverridingProperties
private java.util.Properties getOverridingProperties(CheckstyleExecutorRequest request) throws CheckstyleExecutorException
- Throws:
CheckstyleExecutorException
-
getFilesToProcess
private java.util.List<java.io.File> getFilesToProcess(CheckstyleExecutorRequest request) throws java.io.IOException
- Throws:
java.io.IOException
-
addFilesToProcess
private void addFilesToProcess(CheckstyleExecutorRequest request, java.util.Collection<java.io.File> sourceDirectories, java.util.List<org.apache.maven.model.Resource> resources, java.util.List<org.apache.maven.model.Resource> testResources, java.util.Collection<java.io.File> files, java.util.Collection<java.io.File> testSourceDirectories) throws java.io.IOException
- Throws:
java.io.IOException
-
addResourceFilesToProcess
private void addResourceFilesToProcess(CheckstyleExecutorRequest request, java.util.List<org.apache.maven.model.Resource> resources, java.util.Collection<java.io.File> files) throws java.io.IOException
- Throws:
java.io.IOException
-
getSuppressionsFilterSet
private com.puppycrawl.tools.checkstyle.api.FilterSet getSuppressionsFilterSet(java.lang.String suppressionsFilePath) throws CheckstyleExecutorException
- Throws:
CheckstyleExecutorException
-
getSuppressionsFilePath
private java.lang.String getSuppressionsFilePath(CheckstyleExecutorRequest request) throws CheckstyleExecutorException
- Throws:
CheckstyleExecutorException
-
getConfigFile
private java.lang.String getConfigFile(CheckstyleExecutorRequest request) throws CheckstyleExecutorException
- Throws:
CheckstyleExecutorException
-
configureResourceLocator
private void configureResourceLocator(org.codehaus.plexus.resource.ResourceManager resourceManager, CheckstyleExecutorRequest request, java.util.List<org.apache.maven.artifact.Artifact> additionalArtifacts)
Configures search paths in the resource locator. This method should only be called once per execution.- Parameters:
request
- executor request data.
-
-