Class CheckstyleExecutorRequest


  • public class CheckstyleExecutorRequest
    extends java.lang.Object
    Since:
    2.5
    • 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.
      • getExcludes

        public java.lang.String getExcludes()
      • getResourceIncludes

        public java.lang.String getResourceIncludes()
      • getResourceExcludes

        public java.lang.String getResourceExcludes()
      • getProject

        public org.apache.maven.project.MavenProject getProject()
      • 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()
      • getListener

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

        public boolean isConsoleOutput()
      • 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()
      • getPropertyExpansion

        public java.lang.String getPropertyExpansion()
      • getHeaderLocation

        public java.lang.String getHeaderLocation()
      • getCacheFile

        public java.lang.String getCacheFile()
      • getSuppressionsFileExpression

        public java.lang.String getSuppressionsFileExpression()
      • setSuppressionsFileExpression

        public CheckstyleExecutorRequest setSuppressionsFileExpression​(java.lang.String suppressionsFileExpression)
      • getEncoding

        public java.lang.String getEncoding()
      • getPropertiesLocation

        public java.lang.String getPropertiesLocation()
      • 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.