Class CheckstyleExecutorRequest
java.lang.Object
org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- Since:
- 2.5
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
private String
private String
private List
<org.apache.maven.artifact.Artifact> private boolean
private com.puppycrawl.tools.checkstyle.DefaultLogger
private String
private String
Specifies the names filter of the source files to be excluded for Checkstyle.private boolean
private String
private boolean
private String
Specifies the names filter of the source files to be used for Checkstyle.private boolean
private boolean
private List
<org.apache.maven.artifact.Artifact> private com.puppycrawl.tools.checkstyle.api.AuditListener
private boolean
private org.apache.maven.project.MavenProject
private String
private String
private List
<org.apache.maven.project.MavenProject> private String
Specifies names filter for resources.private String
Specifies names filter for resources.private List
<org.apache.maven.model.Resource> private Collection
<File> private ByteArrayOutputStream
private String
private String
private List
<org.apache.maven.model.Resource> private Collection
<File> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionList
<org.apache.maven.artifact.Artifact> Returns a list of artifacts, which may contain the checkstyle configuration.com.puppycrawl.tools.checkstyle.DefaultLogger
Returns the includes parameter.List
<org.apache.maven.artifact.Artifact> Returns a list of license artifacts, which may contain the license.com.puppycrawl.tools.checkstyle.api.AuditListener
org.apache.maven.project.MavenProject
List
<org.apache.maven.project.MavenProject> Returns the list of reactor projects.List
<org.apache.maven.model.Resource> List
<org.apache.maven.model.Resource> boolean
Returns true if the report is aggregated.boolean
boolean
boolean
boolean
boolean
boolean
Returns true if ignored modules (modules with severity 'ignore') should be omitted.setAggregate
(boolean pAggregate) Sets the aggregate parameter.setCacheFile
(String cacheFile) setConfigLocation
(String configLocation) setConfigurationArtifacts
(List<org.apache.maven.artifact.Artifact> configArtifacts) Sets a list of artifacts, which may contain the checkstyle configuration.setConsoleListener
(com.puppycrawl.tools.checkstyle.DefaultLogger defaultLogger) setConsoleOutput
(boolean consoleOutput) setEncoding
(String encoding) setExcludes
(String excludes) setFailsOnError
(boolean failsOnError) setHeaderLocation
(String headerLocation) setIncludeResources
(boolean includeResources) setIncludes
(String includes) setIncludeTestResources
(boolean includeTestResources) setIncludeTestSourceDirectory
(boolean includeTestSourceDirectory) setLicenseArtifacts
(List<org.apache.maven.artifact.Artifact> licenseArtifacts) Sets a list of license artifacts, which may contain the license.setListener
(com.puppycrawl.tools.checkstyle.api.AuditListener listener) setOmitIgnoredModules
(boolean omitIgnoredModules) setProject
(org.apache.maven.project.MavenProject project) setPropertiesLocation
(String propertiesLocation) setPropertyExpansion
(String propertyExpansion) setReactorProjects
(List<org.apache.maven.project.MavenProject> pReactorProjects) Sets the list of reactor projects.setResourceExcludes
(String resourceExcludes) setResourceIncludes
(String resourceIncludes) setResources
(List<org.apache.maven.model.Resource> resources) setSourceDirectories
(Collection<File> sourceDirectories) setStringOutputStream
(ByteArrayOutputStream stringOutputStream) setSuppressionsFileExpression
(String suppressionsFileExpression) setSuppressionsLocation
(String suppressionsLocation) setTestResources
(List<org.apache.maven.model.Resource> testResources) setTestSourceDirectories
(Collection<File> testSourceDirectories)
-
Field Details
-
includes
Specifies the names filter of the source files to be used for Checkstyle. -
excludes
Specifies the names filter of the source files to be excluded for Checkstyle. -
resourceIncludes
Specifies names filter for resources. -
resourceExcludes
Specifies names filter for resources. -
project
private org.apache.maven.project.MavenProject project -
suppressionsLocation
-
includeTestSourceDirectory
private boolean includeTestSourceDirectory -
testSourceDirectories
-
sourceDirectories
-
includeResources
private boolean includeResources -
includeTestResources
private boolean includeTestResources -
resources
-
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
-
propertiesLocation
-
configLocation
-
propertyExpansion
-
headerLocation
-
cacheFile
-
suppressionsFileExpression
-
encoding
-
aggregate
private boolean aggregate- Since:
- 2.8
-
reactorProjects
- Since:
- 2.8
-
licenseArtifacts
- Since:
- 2.12.1
-
configurationArtifacts
- Since:
- 2.12.1
-
omitIgnoredModules
private boolean omitIgnoredModules- Since:
- 3.0.0
-
-
Constructor Details
-
CheckstyleExecutorRequest
public CheckstyleExecutorRequest()Constructor.
-
-
Method Details
-
getIncludes
Returns the includes parameter.- Returns:
- The includes parameter.
-
setIncludes
-
getExcludes
-
setExcludes
-
getResourceIncludes
-
setResourceIncludes
-
getResourceExcludes
-
setResourceExcludes
-
getProject
public org.apache.maven.project.MavenProject getProject() -
setProject
-
getSuppressionsLocation
-
setSuppressionsLocation
-
isIncludeTestSourceDirectory
public boolean isIncludeTestSourceDirectory() -
setIncludeTestSourceDirectory
-
getTestSourceDirectories
-
setTestSourceDirectories
-
getSourceDirectories
-
setSourceDirectories
-
getResources
-
setResources
-
getTestResources
-
setTestResources
public CheckstyleExecutorRequest setTestResources(List<org.apache.maven.model.Resource> testResources) -
isFailsOnError
public boolean isFailsOnError() -
setFailsOnError
-
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
-
setConsoleListener
public CheckstyleExecutorRequest setConsoleListener(com.puppycrawl.tools.checkstyle.DefaultLogger defaultLogger) -
getConsoleListener
public com.puppycrawl.tools.checkstyle.DefaultLogger getConsoleListener() -
getStringOutputStream
-
setStringOutputStream
-
getConfigLocation
-
setConfigLocation
-
getPropertyExpansion
-
setPropertyExpansion
-
getHeaderLocation
-
setHeaderLocation
-
getCacheFile
-
setCacheFile
-
getSuppressionsFileExpression
-
setSuppressionsFileExpression
-
getEncoding
-
setEncoding
-
getPropertiesLocation
-
setPropertiesLocation
-
isAggregate
public boolean isAggregate()Returns true if the report is aggregated.- Returns:
true
if the report is aggregated.
-
setAggregate
Sets the aggregate parameter.- Parameters:
pAggregate
-true
if an aggregated report is desired.- Returns:
- This object.
-
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
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
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
- Parameters:
includeResources
- whether to include the resource directories in the checks.- Returns:
- This object.
-
isIncludeTestResources
public boolean isIncludeTestResources() -
setIncludeTestResources
- 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
- Parameters:
omitIgnoredModules
- Whether to omit ignored modules (modules with severity 'ignore').- Returns:
- This object.
-