org.apache.maven.plugins.checkstyle.exec

Class CheckstyleExecutorRequest

java.lang.Object

org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest

public class CheckstyleExecutorRequest
extends java.lang.Object

Since:

2.5

Version:

$Id$

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	aggregate
private java.lang.String	cacheFile
private java.lang.String	configLocation
private java.util.List<org.apache.maven.artifact.Artifact>	configurationArtifacts
private boolean	consoleOutput
private com.puppycrawl.tools.checkstyle.DefaultLogger	defaultLogger
private java.lang.String	encoding
private java.lang.String	excludes Specifies the names filter of the source files to be excluded for Checkstyle.
private boolean	failsOnError
private java.lang.String	headerLocation
private boolean	includeResources
private java.lang.String	includes Specifies the names filter of the source files to be used for Checkstyle.
private boolean	includeTestResources
private boolean	includeTestSourceDirectory
private java.util.List<org.apache.maven.artifact.Artifact>	licenseArtifacts
private com.puppycrawl.tools.checkstyle.api.AuditListener	listener
private boolean	omitIgnoredModules
private org.apache.maven.project.MavenProject	project
private java.lang.String	propertiesLocation
private java.lang.String	propertyExpansion
private java.util.List<org.apache.maven.project.MavenProject>	reactorProjects
private java.lang.String	resourceExcludes Specifies names filter for resources.
private java.lang.String	resourceIncludes Specifies names filter for resources.
private java.util.List<org.apache.maven.model.Resource>	resources
private java.util.Collection<java.io.File>	sourceDirectories
private java.io.ByteArrayOutputStream	stringOutputStream
private java.lang.String	suppressionsFileExpression
private java.lang.String	suppressionsLocation
private java.util.List<org.apache.maven.model.Resource>	testResources
private java.util.Collection<java.io.File>	testSourceDirectories

Constructor Summary

Constructors

Constructor and Description
CheckstyleExecutorRequest() Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCacheFile()
java.lang.String	getConfigLocation()
java.util.List<org.apache.maven.artifact.Artifact>	getConfigurationArtifacts() Returns a list of artifacts, which may contain the checkstyle configuration.
com.puppycrawl.tools.checkstyle.DefaultLogger	getConsoleListener()
java.lang.String	getEncoding()
java.lang.String	getExcludes()
java.lang.String	getHeaderLocation()
java.lang.String	getIncludes() Returns the includes parameter.
java.util.List<org.apache.maven.artifact.Artifact>	getLicenseArtifacts() Returns a list of license artifacts, which may contain the license.
com.puppycrawl.tools.checkstyle.api.AuditListener	getListener()
org.apache.maven.project.MavenProject	getProject()
java.lang.String	getPropertiesLocation()
java.lang.String	getPropertyExpansion()
java.util.List<org.apache.maven.project.MavenProject>	getReactorProjects() Returns the list of reactor projects.
java.lang.String	getResourceExcludes()
java.lang.String	getResourceIncludes()
java.util.List<org.apache.maven.model.Resource>	getResources()
java.util.Collection<java.io.File>	getSourceDirectories()
java.io.ByteArrayOutputStream	getStringOutputStream()
java.lang.String	getSuppressionsFileExpression()
java.lang.String	getSuppressionsLocation()
java.util.List<org.apache.maven.model.Resource>	getTestResources()
java.util.Collection<java.io.File>	getTestSourceDirectories()
boolean	isAggregate() Returns true if the report is aggregated.
boolean	isConsoleOutput()
boolean	isFailsOnError()
boolean	isIncludeResources()
boolean	isIncludeTestResources()
boolean	isIncludeTestSourceDirectory()
boolean	isOmitIgnoredModules() Returns true if ignored modules (modules with severity 'ignore') should be omitted.
CheckstyleExecutorRequest	setAggregate(boolean pAggregate) Sets the aggregate parameter.
CheckstyleExecutorRequest	setCacheFile(java.lang.String cacheFile)
CheckstyleExecutorRequest	setConfigLocation(java.lang.String configLocation)
CheckstyleExecutorRequest	setConfigurationArtifacts(java.util.List<org.apache.maven.artifact.Artifact> configArtifacts) Sets a list of artifacts, which may contain the checkstyle configuration.
CheckstyleExecutorRequest	setConsoleListener(com.puppycrawl.tools.checkstyle.DefaultLogger defaultLogger)
CheckstyleExecutorRequest	setConsoleOutput(boolean consoleOutput)
CheckstyleExecutorRequest	setEncoding(java.lang.String encoding)
CheckstyleExecutorRequest	setExcludes(java.lang.String excludes)
CheckstyleExecutorRequest	setFailsOnError(boolean failsOnError)
CheckstyleExecutorRequest	setHeaderLocation(java.lang.String headerLocation)
CheckstyleExecutorRequest	setIncludeResources(boolean includeResources)
CheckstyleExecutorRequest	setIncludes(java.lang.String includes)
CheckstyleExecutorRequest	setIncludeTestResources(boolean includeTestResources)
CheckstyleExecutorRequest	setIncludeTestSourceDirectory(boolean includeTestSourceDirectory)
CheckstyleExecutorRequest	setLicenseArtifacts(java.util.List<org.apache.maven.artifact.Artifact> licenseArtifacts) Sets a list of license artifacts, which may contain the license.
CheckstyleExecutorRequest	setListener(com.puppycrawl.tools.checkstyle.api.AuditListener listener)
CheckstyleExecutorRequest	setOmitIgnoredModules(boolean omitIgnoredModules)
CheckstyleExecutorRequest	setProject(org.apache.maven.project.MavenProject project)
CheckstyleExecutorRequest	setPropertiesLocation(java.lang.String propertiesLocation)
CheckstyleExecutorRequest	setPropertyExpansion(java.lang.String propertyExpansion)
CheckstyleExecutorRequest	setReactorProjects(java.util.List<org.apache.maven.project.MavenProject> pReactorProjects) Sets the list of reactor projects.
CheckstyleExecutorRequest	setResourceExcludes(java.lang.String resourceExcludes)
CheckstyleExecutorRequest	setResourceIncludes(java.lang.String resourceIncludes)
CheckstyleExecutorRequest	setResources(java.util.List<org.apache.maven.model.Resource> resources)
CheckstyleExecutorRequest	setSourceDirectories(java.util.Collection<java.io.File> sourceDirectories)
CheckstyleExecutorRequest	setStringOutputStream(java.io.ByteArrayOutputStream stringOutputStream)
CheckstyleExecutorRequest	setSuppressionsFileExpression(java.lang.String suppressionsFileExpression)
CheckstyleExecutorRequest	setSuppressionsLocation(java.lang.String suppressionsLocation)
CheckstyleExecutorRequest	setTestResources(java.util.List<org.apache.maven.model.Resource> testResources)
CheckstyleExecutorRequest	setTestSourceDirectories(java.util.Collection<java.io.File> testSourceDirectories)

Methods inherited from class java.lang.Object

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

Field Detail

includes

private java.lang.String includes

Specifies the names filter of the source files to be used for Checkstyle.

excludes

private java.lang.String excludes

Specifies the names filter of the source files to be excluded for Checkstyle.

resourceIncludes

private java.lang.String resourceIncludes

Specifies names filter for resources.

resourceExcludes

private java.lang.String resourceExcludes

Specifies names filter for resources.

project

private org.apache.maven.project.MavenProject project

suppressionsLocation

private java.lang.String suppressionsLocation

includeTestSourceDirectory

private boolean includeTestSourceDirectory

testSourceDirectories

private java.util.Collection<java.io.File> testSourceDirectories

sourceDirectories

private java.util.Collection<java.io.File> sourceDirectories

includeResources

private boolean includeResources

includeTestResources

private boolean includeTestResources

resources

private java.util.List<org.apache.maven.model.Resource> resources

testResources

private java.util.List<org.apache.maven.model.Resource> testResources

failsOnError

private boolean failsOnError

listener

private com.puppycrawl.tools.checkstyle.api.AuditListener listener

consoleOutput

private boolean consoleOutput

defaultLogger

private com.puppycrawl.tools.checkstyle.DefaultLogger defaultLogger

stringOutputStream

private java.io.ByteArrayOutputStream stringOutputStream

propertiesLocation

private java.lang.String propertiesLocation

configLocation

private java.lang.String configLocation

propertyExpansion

private java.lang.String propertyExpansion

headerLocation

private java.lang.String headerLocation

cacheFile

private java.lang.String cacheFile

suppressionsFileExpression

private java.lang.String suppressionsFileExpression

encoding

private java.lang.String encoding

aggregate

private boolean aggregate

Since:

2.8

reactorProjects

private java.util.List<org.apache.maven.project.MavenProject> reactorProjects

Since:

2.8

licenseArtifacts

private java.util.List<org.apache.maven.artifact.Artifact> licenseArtifacts

Since:

2.12.1

configurationArtifacts

private java.util.List<org.apache.maven.artifact.Artifact> configurationArtifacts

Since:

2.12.1

omitIgnoredModules

private boolean omitIgnoredModules

Since:

3.0.0

Constructor Detail

CheckstyleExecutorRequest

public CheckstyleExecutorRequest()

Constructor.

Method Detail

getIncludes

public java.lang.String getIncludes()

Returns the includes parameter.

Returns:

The includes parameter.

setIncludes

public CheckstyleExecutorRequest setIncludes(java.lang.String includes)

getExcludes

public java.lang.String getExcludes()

setExcludes

public CheckstyleExecutorRequest setExcludes(java.lang.String excludes)

getResourceIncludes

public java.lang.String getResourceIncludes()

setResourceIncludes

public CheckstyleExecutorRequest setResourceIncludes(java.lang.String resourceIncludes)

getResourceExcludes

public java.lang.String getResourceExcludes()

setResourceExcludes

public CheckstyleExecutorRequest setResourceExcludes(java.lang.String resourceExcludes)

getProject

public org.apache.maven.project.MavenProject getProject()

setProject

public CheckstyleExecutorRequest setProject(org.apache.maven.project.MavenProject project)

getSuppressionsLocation

public java.lang.String getSuppressionsLocation()

setSuppressionsLocation

public CheckstyleExecutorRequest setSuppressionsLocation(java.lang.String suppressionsLocation)

isIncludeTestSourceDirectory

public boolean isIncludeTestSourceDirectory()

setIncludeTestSourceDirectory

public CheckstyleExecutorRequest setIncludeTestSourceDirectory(boolean includeTestSourceDirectory)

getTestSourceDirectories

public java.util.Collection<java.io.File> getTestSourceDirectories()

setTestSourceDirectories

public CheckstyleExecutorRequest setTestSourceDirectories(java.util.Collection<java.io.File> testSourceDirectories)

getSourceDirectories

public java.util.Collection<java.io.File> getSourceDirectories()

setSourceDirectories

public CheckstyleExecutorRequest setSourceDirectories(java.util.Collection<java.io.File> sourceDirectories)

getResources

public java.util.List<org.apache.maven.model.Resource> getResources()

setResources

public CheckstyleExecutorRequest setResources(java.util.List<org.apache.maven.model.Resource> resources)

getTestResources

public java.util.List<org.apache.maven.model.Resource> getTestResources()

setTestResources

public CheckstyleExecutorRequest setTestResources(java.util.List<org.apache.maven.model.Resource> testResources)

isFailsOnError

public boolean isFailsOnError()

setFailsOnError

public CheckstyleExecutorRequest setFailsOnError(boolean failsOnError)

getListener

public com.puppycrawl.tools.checkstyle.api.AuditListener getListener()

setListener

public CheckstyleExecutorRequest setListener(com.puppycrawl.tools.checkstyle.api.AuditListener listener)

isConsoleOutput

public boolean isConsoleOutput()

setConsoleOutput

public CheckstyleExecutorRequest setConsoleOutput(boolean consoleOutput)

setConsoleListener

public CheckstyleExecutorRequest setConsoleListener(com.puppycrawl.tools.checkstyle.DefaultLogger defaultLogger)

getConsoleListener

public com.puppycrawl.tools.checkstyle.DefaultLogger getConsoleListener()

getStringOutputStream

public java.io.ByteArrayOutputStream getStringOutputStream()

setStringOutputStream

public CheckstyleExecutorRequest setStringOutputStream(java.io.ByteArrayOutputStream stringOutputStream)

getConfigLocation

public java.lang.String getConfigLocation()

setConfigLocation

public CheckstyleExecutorRequest setConfigLocation(java.lang.String configLocation)

getPropertyExpansion

public java.lang.String getPropertyExpansion()

setPropertyExpansion

public CheckstyleExecutorRequest setPropertyExpansion(java.lang.String propertyExpansion)

getHeaderLocation

public java.lang.String getHeaderLocation()

setHeaderLocation

public CheckstyleExecutorRequest setHeaderLocation(java.lang.String headerLocation)

getCacheFile

public java.lang.String getCacheFile()

setCacheFile

public CheckstyleExecutorRequest setCacheFile(java.lang.String cacheFile)

getSuppressionsFileExpression

public java.lang.String getSuppressionsFileExpression()

setSuppressionsFileExpression

public CheckstyleExecutorRequest setSuppressionsFileExpression(java.lang.String suppressionsFileExpression)

getEncoding

public java.lang.String getEncoding()

setEncoding

public CheckstyleExecutorRequest setEncoding(java.lang.String encoding)

getPropertiesLocation

public java.lang.String getPropertiesLocation()

setPropertiesLocation

public CheckstyleExecutorRequest setPropertiesLocation(java.lang.String propertiesLocation)

isAggregate

public boolean isAggregate()

Returns true if the report is aggregated.

Returns:

true if the report is aggregated.

setAggregate

public CheckstyleExecutorRequest setAggregate(boolean pAggregate)

Sets the aggregate parameter.

Parameters:

pAggregate - true if an aggregated report is desired.

Returns:

This object.

getReactorProjects

public java.util.List<org.apache.maven.project.MavenProject> getReactorProjects()

Returns the list of reactor projects.

Returns:

The reactor projects.

setReactorProjects

public CheckstyleExecutorRequest setReactorProjects(java.util.List<org.apache.maven.project.MavenProject> pReactorProjects)

Sets the list of reactor projects.

Parameters:

pReactorProjects - The reactor projects.

Returns:

This object.

getLicenseArtifacts

public java.util.List<org.apache.maven.artifact.Artifact> getLicenseArtifacts()

Returns a list of license artifacts, which may contain the license.

Returns:

the license artifacts

setLicenseArtifacts

public CheckstyleExecutorRequest setLicenseArtifacts(java.util.List<org.apache.maven.artifact.Artifact> licenseArtifacts)

Sets a list of license artifacts, which may contain the license.

Parameters:

licenseArtifacts - List of license artifacts.

Returns:

This object.

getConfigurationArtifacts

public java.util.List<org.apache.maven.artifact.Artifact> getConfigurationArtifacts()

Returns a list of artifacts, which may contain the checkstyle configuration.

Returns:

the license artifacts

setConfigurationArtifacts

public CheckstyleExecutorRequest setConfigurationArtifacts(java.util.List<org.apache.maven.artifact.Artifact> configArtifacts)

Sets a list of artifacts, which may contain the checkstyle configuration.

Parameters:

configArtifacts - List of artifacts.

Returns:

This object.

isIncludeResources

public boolean isIncludeResources()

setIncludeResources

public CheckstyleExecutorRequest setIncludeResources(boolean includeResources)

Parameters:

includeResources - whether to include the resource directories in the checks.

Returns:

This object.

isIncludeTestResources

public boolean isIncludeTestResources()

setIncludeTestResources

public CheckstyleExecutorRequest setIncludeTestResources(boolean includeTestResources)

Parameters:

includeTestResources - whether to set the test resource directories in the checks.

Returns:

This object.

isOmitIgnoredModules

public boolean isOmitIgnoredModules()

Returns true if ignored modules (modules with severity 'ignore') should be omitted.

Returns:

true if ignored modules should be omitted.

setOmitIgnoredModules

public CheckstyleExecutorRequest setOmitIgnoredModules(boolean omitIgnoredModules)

Parameters:

omitIgnoredModules - Whether to omit ignored modules (modules with severity 'ignore').

Returns:

This object.