Class CheckstyleExecutorRequest
- java.lang.Object
-
- org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
public class CheckstyleExecutorRequest extends java.lang.Object
- Since:
- 2.5
- Author:
- Olivier Lamy
-
-
Constructor Summary
Constructors Constructor Description CheckstyleExecutorRequest()
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getCacheFile()
java.lang.String
getConfigLocation()
java.util.List<Artifact>
getConfigurationArtifacts()
Returns a list of artifacts, which may contain the checkstyle configuration.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<Artifact>
getLicenseArtifacts()
Returns a list of license artifacts, which may contain the license.AuditListener
getListener()
MavenProject
getProject()
java.lang.String
getPropertiesLocation()
java.lang.String
getPropertyExpansion()
java.util.List<MavenProject>
getReactorProjects()
Returns the list of reactor projects.java.lang.String
getResourceExcludes()
java.lang.String
getResourceIncludes()
java.util.List<Resource>
getResources()
java.util.Collection<java.io.File>
getSourceDirectories()
java.io.ByteArrayOutputStream
getStringOutputStream()
java.lang.String
getSuppressionsFileExpression()
java.lang.String
getSuppressionsLocation()
java.util.List<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<Artifact> configArtifacts)
Sets a list of artifacts, which may contain the checkstyle configuration.CheckstyleExecutorRequest
setConsoleListener(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<Artifact> licenseArtifacts)
Sets a list of license artifacts, which may contain the license.CheckstyleExecutorRequest
setListener(AuditListener listener)
CheckstyleExecutorRequest
setOmitIgnoredModules(boolean omitIgnoredModules)
CheckstyleExecutorRequest
setProject(MavenProject project)
CheckstyleExecutorRequest
setPropertiesLocation(java.lang.String propertiesLocation)
CheckstyleExecutorRequest
setPropertyExpansion(java.lang.String propertyExpansion)
CheckstyleExecutorRequest
setReactorProjects(java.util.List<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<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<Resource> testResources)
CheckstyleExecutorRequest
setTestSourceDirectories(java.util.Collection<java.io.File> testSourceDirectories)
-
-
-
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 MavenProject getProject()
-
setProject
public CheckstyleExecutorRequest setProject(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<Resource> getResources()
-
setResources
public CheckstyleExecutorRequest setResources(java.util.List<Resource> resources)
-
getTestResources
public java.util.List<Resource> getTestResources()
-
setTestResources
public CheckstyleExecutorRequest setTestResources(java.util.List<Resource> testResources)
-
isFailsOnError
public boolean isFailsOnError()
-
setFailsOnError
public CheckstyleExecutorRequest setFailsOnError(boolean failsOnError)
-
getListener
public AuditListener getListener()
-
setListener
public CheckstyleExecutorRequest setListener(AuditListener listener)
-
isConsoleOutput
public boolean isConsoleOutput()
-
setConsoleOutput
public CheckstyleExecutorRequest setConsoleOutput(boolean consoleOutput)
-
setConsoleListener
public CheckstyleExecutorRequest setConsoleListener(DefaultLogger defaultLogger)
-
getConsoleListener
public 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<MavenProject> getReactorProjects()
Returns the list of reactor projects.- Returns:
- The reactor projects.
-
setReactorProjects
public CheckstyleExecutorRequest setReactorProjects(java.util.List<MavenProject> pReactorProjects)
Sets the list of reactor projects.- Parameters:
pReactorProjects
- The reactor projects.- Returns:
- This object.
-
getLicenseArtifacts
public java.util.List<Artifact> getLicenseArtifacts()
Returns a list of license artifacts, which may contain the license.- Returns:
- the license artifacts
-
setLicenseArtifacts
public CheckstyleExecutorRequest setLicenseArtifacts(java.util.List<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<Artifact> getConfigurationArtifacts()
Returns a list of artifacts, which may contain the checkstyle configuration.- Returns:
- the license artifacts
-
setConfigurationArtifacts
public CheckstyleExecutorRequest setConfigurationArtifacts(java.util.List<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.
-
-