Class CheckstyleExecutorRequest


  • public class CheckstyleExecutorRequest
    extends Object
    Since:
    2.5
    Version:
    $Id$
    Author:
    Olivier Lamy
    • Constructor Detail

      • CheckstyleExecutorRequest

        public CheckstyleExecutorRequest()
        Constructor.
    • Method Detail

      • getIncludes

        public String getIncludes()
        Returns the includes parameter.
        Returns:
        The includes parameter.
      • getExcludes

        public String getExcludes()
      • getResourceIncludes

        public String getResourceIncludes()
      • getResourceExcludes

        public String getResourceExcludes()
      • getProject

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

        public String getSuppressionsLocation()
      • isIncludeTestSourceDirectory

        public boolean isIncludeTestSourceDirectory()
      • setIncludeTestSourceDirectory

        public CheckstyleExecutorRequest setIncludeTestSourceDirectory​(boolean includeTestSourceDirectory)
      • getTestSourceDirectories

        public Collection<File> getTestSourceDirectories()
      • getSourceDirectories

        public Collection<File> getSourceDirectories()
      • getResources

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

        public List<org.apache.maven.model.Resource> getTestResources()
      • 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()
      • getConfigLocation

        public String getConfigLocation()
      • getPropertyExpansion

        public String getPropertyExpansion()
      • getHeaderLocation

        public String getHeaderLocation()
      • getCacheFile

        public String getCacheFile()
      • getSuppressionsFileExpression

        public String getSuppressionsFileExpression()
      • getEncoding

        public String getEncoding()
      • getPropertiesLocation

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