org.apache.maven.plugins.checkstyle.exec

Class CheckstyleExecutorRequest

java.lang.Object

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

public class CheckstyleExecutorRequest
extends Object

Since:

2.5

Author:

Olivier Lamy

Constructor Summary

Constructors

Constructor and Description
CheckstyleExecutorRequest() Constructor.

Method Summary

Modifier and Type	Method and Description
String	getCacheFile()
String	getConfigLocation()
List<org.apache.maven.artifact.Artifact>	getConfigurationArtifacts() Returns a list of artifacts, which may contain the checkstyle configuration.
com.puppycrawl.tools.checkstyle.DefaultLogger	getConsoleListener()
String	getEncoding()
String	getExcludes()
String	getHeaderLocation()
String	getIncludes() Returns the includes parameter.
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()
String	getPropertiesLocation()
String	getPropertyExpansion()
List<org.apache.maven.project.MavenProject>	getReactorProjects() Returns the list of reactor projects.
String	getResourceExcludes()
String	getResourceIncludes()
List<org.apache.maven.model.Resource>	getResources()
Collection<File>	getSourceDirectories()
ByteArrayOutputStream	getStringOutputStream()
String	getSuppressionsFileExpression()
String	getSuppressionsLocation()
List<org.apache.maven.model.Resource>	getTestResources()
Collection<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(String cacheFile)
CheckstyleExecutorRequest	setConfigLocation(String configLocation)
CheckstyleExecutorRequest	setConfigurationArtifacts(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(String encoding)
CheckstyleExecutorRequest	setExcludes(String excludes)
CheckstyleExecutorRequest	setFailsOnError(boolean failsOnError)
CheckstyleExecutorRequest	setHeaderLocation(String headerLocation)
CheckstyleExecutorRequest	setIncludeResources(boolean includeResources)
CheckstyleExecutorRequest	setIncludes(String includes)
CheckstyleExecutorRequest	setIncludeTestResources(boolean includeTestResources)
CheckstyleExecutorRequest	setIncludeTestSourceDirectory(boolean includeTestSourceDirectory)
CheckstyleExecutorRequest	setLicenseArtifacts(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(String propertiesLocation)
CheckstyleExecutorRequest	setPropertyExpansion(String propertyExpansion)
CheckstyleExecutorRequest	setReactorProjects(List<org.apache.maven.project.MavenProject> pReactorProjects) Sets the list of reactor projects.
CheckstyleExecutorRequest	setResourceExcludes(String resourceExcludes)
CheckstyleExecutorRequest	setResourceIncludes(String resourceIncludes)
CheckstyleExecutorRequest	setResources(List<org.apache.maven.model.Resource> resources)
CheckstyleExecutorRequest	setSourceDirectories(Collection<File> sourceDirectories)
CheckstyleExecutorRequest	setStringOutputStream(ByteArrayOutputStream stringOutputStream)
CheckstyleExecutorRequest	setSuppressionsFileExpression(String suppressionsFileExpression)
CheckstyleExecutorRequest	setSuppressionsLocation(String suppressionsLocation)
CheckstyleExecutorRequest	setTestResources(List<org.apache.maven.model.Resource> testResources)
CheckstyleExecutorRequest	setTestSourceDirectories(Collection<File> testSourceDirectories)

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckstyleExecutorRequest

public CheckstyleExecutorRequest()

Constructor.

Method Detail

getIncludes

public String getIncludes()

Returns the includes parameter.

Returns:

The includes parameter.

setIncludes

public CheckstyleExecutorRequest setIncludes(String includes)

getExcludes

public String getExcludes()

setExcludes

public CheckstyleExecutorRequest setExcludes(String excludes)

getResourceIncludes

public String getResourceIncludes()

setResourceIncludes

public CheckstyleExecutorRequest setResourceIncludes(String resourceIncludes)

getResourceExcludes

public String getResourceExcludes()

setResourceExcludes

public CheckstyleExecutorRequest setResourceExcludes(String resourceExcludes)

getProject

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

setProject

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

getSuppressionsLocation

public String getSuppressionsLocation()

setSuppressionsLocation

public CheckstyleExecutorRequest setSuppressionsLocation(String suppressionsLocation)

isIncludeTestSourceDirectory

public boolean isIncludeTestSourceDirectory()

setIncludeTestSourceDirectory

public CheckstyleExecutorRequest setIncludeTestSourceDirectory(boolean includeTestSourceDirectory)

getTestSourceDirectories

public Collection<File> getTestSourceDirectories()

setTestSourceDirectories

public CheckstyleExecutorRequest setTestSourceDirectories(Collection<File> testSourceDirectories)

getSourceDirectories

public Collection<File> getSourceDirectories()

setSourceDirectories

public CheckstyleExecutorRequest setSourceDirectories(Collection<File> sourceDirectories)

getResources

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

setResources

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

getTestResources

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

setTestResources

public CheckstyleExecutorRequest setTestResources(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 ByteArrayOutputStream getStringOutputStream()

setStringOutputStream

public CheckstyleExecutorRequest setStringOutputStream(ByteArrayOutputStream stringOutputStream)

getConfigLocation

public String getConfigLocation()

setConfigLocation

public CheckstyleExecutorRequest setConfigLocation(String configLocation)

getPropertyExpansion

public String getPropertyExpansion()

setPropertyExpansion

public CheckstyleExecutorRequest setPropertyExpansion(String propertyExpansion)

getHeaderLocation

public String getHeaderLocation()

setHeaderLocation

public CheckstyleExecutorRequest setHeaderLocation(String headerLocation)

getCacheFile

public String getCacheFile()

setCacheFile

public CheckstyleExecutorRequest setCacheFile(String cacheFile)

getSuppressionsFileExpression

public String getSuppressionsFileExpression()

setSuppressionsFileExpression

public CheckstyleExecutorRequest setSuppressionsFileExpression(String suppressionsFileExpression)

getEncoding

public String getEncoding()

setEncoding

public CheckstyleExecutorRequest setEncoding(String encoding)

getPropertiesLocation

public String getPropertiesLocation()

setPropertiesLocation

public CheckstyleExecutorRequest setPropertiesLocation(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 List<org.apache.maven.project.MavenProject> getReactorProjects()

Returns the list of reactor projects.

Returns:

The reactor projects.

setReactorProjects

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

Sets the list of reactor projects.

Parameters:

pReactorProjects - The reactor projects.

Returns:

This object.

getLicenseArtifacts

public 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(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 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(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.