public class CheckstyleExecutorRequest
extends java.lang.Object
| 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 and Description |
|---|
CheckstyleExecutorRequest()
Constructor.
|
| 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) |
private java.lang.String includes
private java.lang.String excludes
private java.lang.String resourceIncludes
private java.lang.String resourceExcludes
private org.apache.maven.project.MavenProject project
private java.lang.String suppressionsLocation
private boolean includeTestSourceDirectory
private java.util.Collection<java.io.File> testSourceDirectories
private java.util.Collection<java.io.File> sourceDirectories
private boolean includeResources
private boolean includeTestResources
private java.util.List<org.apache.maven.model.Resource> resources
private java.util.List<org.apache.maven.model.Resource> testResources
private boolean failsOnError
private com.puppycrawl.tools.checkstyle.api.AuditListener listener
private boolean consoleOutput
private com.puppycrawl.tools.checkstyle.DefaultLogger defaultLogger
private java.io.ByteArrayOutputStream stringOutputStream
private java.lang.String propertiesLocation
private java.lang.String configLocation
private java.lang.String propertyExpansion
private java.lang.String headerLocation
private java.lang.String cacheFile
private java.lang.String suppressionsFileExpression
private java.lang.String encoding
private boolean aggregate
private java.util.List<org.apache.maven.project.MavenProject> reactorProjects
private java.util.List<org.apache.maven.artifact.Artifact> licenseArtifacts
private java.util.List<org.apache.maven.artifact.Artifact> configurationArtifacts
private boolean omitIgnoredModules
public java.lang.String getIncludes()
public CheckstyleExecutorRequest setIncludes(java.lang.String includes)
public java.lang.String getExcludes()
public CheckstyleExecutorRequest setExcludes(java.lang.String excludes)
public java.lang.String getResourceIncludes()
public CheckstyleExecutorRequest setResourceIncludes(java.lang.String resourceIncludes)
public java.lang.String getResourceExcludes()
public CheckstyleExecutorRequest setResourceExcludes(java.lang.String resourceExcludes)
public org.apache.maven.project.MavenProject getProject()
public CheckstyleExecutorRequest setProject(org.apache.maven.project.MavenProject project)
public java.lang.String getSuppressionsLocation()
public CheckstyleExecutorRequest setSuppressionsLocation(java.lang.String suppressionsLocation)
public boolean isIncludeTestSourceDirectory()
public CheckstyleExecutorRequest setIncludeTestSourceDirectory(boolean includeTestSourceDirectory)
public java.util.Collection<java.io.File> getTestSourceDirectories()
public CheckstyleExecutorRequest setTestSourceDirectories(java.util.Collection<java.io.File> testSourceDirectories)
public java.util.Collection<java.io.File> getSourceDirectories()
public CheckstyleExecutorRequest setSourceDirectories(java.util.Collection<java.io.File> sourceDirectories)
public java.util.List<org.apache.maven.model.Resource> getResources()
public CheckstyleExecutorRequest setResources(java.util.List<org.apache.maven.model.Resource> resources)
public java.util.List<org.apache.maven.model.Resource> getTestResources()
public CheckstyleExecutorRequest setTestResources(java.util.List<org.apache.maven.model.Resource> testResources)
public boolean isFailsOnError()
public CheckstyleExecutorRequest setFailsOnError(boolean failsOnError)
public com.puppycrawl.tools.checkstyle.api.AuditListener getListener()
public CheckstyleExecutorRequest setListener(com.puppycrawl.tools.checkstyle.api.AuditListener listener)
public boolean isConsoleOutput()
public CheckstyleExecutorRequest setConsoleOutput(boolean consoleOutput)
public CheckstyleExecutorRequest setConsoleListener(com.puppycrawl.tools.checkstyle.DefaultLogger defaultLogger)
public com.puppycrawl.tools.checkstyle.DefaultLogger getConsoleListener()
public java.io.ByteArrayOutputStream getStringOutputStream()
public CheckstyleExecutorRequest setStringOutputStream(java.io.ByteArrayOutputStream stringOutputStream)
public java.lang.String getConfigLocation()
public CheckstyleExecutorRequest setConfigLocation(java.lang.String configLocation)
public java.lang.String getPropertyExpansion()
public CheckstyleExecutorRequest setPropertyExpansion(java.lang.String propertyExpansion)
public java.lang.String getHeaderLocation()
public CheckstyleExecutorRequest setHeaderLocation(java.lang.String headerLocation)
public java.lang.String getCacheFile()
public CheckstyleExecutorRequest setCacheFile(java.lang.String cacheFile)
public java.lang.String getSuppressionsFileExpression()
public CheckstyleExecutorRequest setSuppressionsFileExpression(java.lang.String suppressionsFileExpression)
public java.lang.String getEncoding()
public CheckstyleExecutorRequest setEncoding(java.lang.String encoding)
public java.lang.String getPropertiesLocation()
public CheckstyleExecutorRequest setPropertiesLocation(java.lang.String propertiesLocation)
public boolean isAggregate()
true if the report is aggregated.public CheckstyleExecutorRequest setAggregate(boolean pAggregate)
pAggregate - true if an aggregated report is desired.public java.util.List<org.apache.maven.project.MavenProject> getReactorProjects()
public CheckstyleExecutorRequest setReactorProjects(java.util.List<org.apache.maven.project.MavenProject> pReactorProjects)
pReactorProjects - The reactor projects.public java.util.List<org.apache.maven.artifact.Artifact> getLicenseArtifacts()
public CheckstyleExecutorRequest setLicenseArtifacts(java.util.List<org.apache.maven.artifact.Artifact> licenseArtifacts)
licenseArtifacts - List of license artifacts.public java.util.List<org.apache.maven.artifact.Artifact> getConfigurationArtifacts()
public CheckstyleExecutorRequest setConfigurationArtifacts(java.util.List<org.apache.maven.artifact.Artifact> configArtifacts)
configArtifacts - List of artifacts.public boolean isIncludeResources()
public CheckstyleExecutorRequest setIncludeResources(boolean includeResources)
includeResources - whether to include the resource directories in the checks.public boolean isIncludeTestResources()
public CheckstyleExecutorRequest setIncludeTestResources(boolean includeTestResources)
includeTestResources - whether to set the test resource directories in the checks.public boolean isOmitIgnoredModules()
true if ignored modules should be omitted.public CheckstyleExecutorRequest setOmitIgnoredModules(boolean omitIgnoredModules)
omitIgnoredModules - Whether to omit ignored modules (modules with severity 'ignore').