Package org.apache.maven.plugins.checkstyle.exec

Class CheckstyleExecutorRequest

java.lang.Object
org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
public class CheckstyleExecutorRequest extends Object
Since:
2.5

  • Field Details

    • includes

      private String includes
      Specifies the names filter of the source files to be used for Checkstyle.

    • excludes

      private String excludes
      Specifies the names filter of the source files to be excluded for Checkstyle.

    • resourceIncludes

      private String resourceIncludes
      Specifies names filter for resources.

    • resourceExcludes

      private String resourceExcludes
      Specifies names filter for resources.

    • project

      private org.apache.maven.project.MavenProject project

    • suppressionsLocation

      private String suppressionsLocation

    • includeTestSourceDirectory

      private boolean includeTestSourceDirectory

    • testSourceDirectories

      private Collection<File> testSourceDirectories

    • sourceDirectories

      private Collection<File> sourceDirectories

    • includeResources

      private boolean includeResources

    • includeTestResources

      private boolean includeTestResources

    • resources

      private List<org.apache.maven.model.Resource> resources

    • testResources

      private 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 ByteArrayOutputStream stringOutputStream

    • propertiesLocation

      private String propertiesLocation

    • configLocation

      private String configLocation

    • propertyExpansion

      private String propertyExpansion

    • headerLocation

      private String headerLocation

    • cacheFile

      private String cacheFile

    • suppressionsFileExpression

      private String suppressionsFileExpression

    • encoding

      private String encoding

    • aggregate

      private boolean aggregate
      Since:
      2.8

    • reactorProjects

      private List<org.apache.maven.project.MavenProject> reactorProjects
      Since:
      2.8

    • licenseArtifacts

      private List<org.apache.maven.artifact.Artifact> licenseArtifacts
      Since:
      2.12.1

    • configurationArtifacts

      private List<org.apache.maven.artifact.Artifact> configurationArtifacts
      Since:
      2.12.1

    • omitIgnoredModules

      private boolean omitIgnoredModules
      Since:
      3.0.0

  • Constructor Details

    • CheckstyleExecutorRequest

      public CheckstyleExecutorRequest()
      Constructor.

  • Method Details

    • getIncludes

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

    • setIncludes

      public CheckstyleExecutorRequest setIncludes(String includes)

    • getExcludes

      public String getExcludes()

    • setExcludes

      public CheckstyleExecutorRequest setExcludes(String excludes)

    • getResourceIncludes

      public String getResourceIncludes()

    • setResourceIncludes

      public CheckstyleExecutorRequest setResourceIncludes(String resourceIncludes)

    • getResourceExcludes

      public String getResourceExcludes()

    • setResourceExcludes

      public CheckstyleExecutorRequest setResourceExcludes(String resourceExcludes)

    • getProject

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

    • setProject

      public CheckstyleExecutorRequest setProject(org.apache.maven.project.MavenProject project)

    • getSuppressionsLocation

      public String getSuppressionsLocation()

    • setSuppressionsLocation

      public CheckstyleExecutorRequest setSuppressionsLocation(String suppressionsLocation)

    • isIncludeTestSourceDirectory

      public boolean isIncludeTestSourceDirectory()

    • setIncludeTestSourceDirectory

      public CheckstyleExecutorRequest setIncludeTestSourceDirectory(boolean includeTestSourceDirectory)

    • getTestSourceDirectories

      public Collection<File> getTestSourceDirectories()

    • setTestSourceDirectories

      public CheckstyleExecutorRequest setTestSourceDirectories(Collection<File> testSourceDirectories)

    • getSourceDirectories

      public Collection<File> getSourceDirectories()

    • setSourceDirectories

      public CheckstyleExecutorRequest setSourceDirectories(Collection<File> sourceDirectories)

    • getResources

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

    • setResources

      public CheckstyleExecutorRequest setResources(List<org.apache.maven.model.Resource> resources)

    • getTestResources

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

    • setTestResources

      public CheckstyleExecutorRequest setTestResources(List<org.apache.maven.model.Resource> testResources)

    • isFailsOnError

      public boolean isFailsOnError()

    • setFailsOnError

      public CheckstyleExecutorRequest setFailsOnError(boolean failsOnError)

    • 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

      public CheckstyleExecutorRequest setConsoleOutput(boolean consoleOutput)

    • setConsoleListener

      public CheckstyleExecutorRequest setConsoleListener(com.puppycrawl.tools.checkstyle.DefaultLogger defaultLogger)

    • getConsoleListener

      public com.puppycrawl.tools.checkstyle.DefaultLogger getConsoleListener()

    • getStringOutputStream

      public ByteArrayOutputStream getStringOutputStream()

    • setStringOutputStream

      public CheckstyleExecutorRequest setStringOutputStream(ByteArrayOutputStream stringOutputStream)

    • getConfigLocation

      public String getConfigLocation()

    • setConfigLocation

      public CheckstyleExecutorRequest setConfigLocation(String configLocation)

    • getPropertyExpansion

      public String getPropertyExpansion()

    • setPropertyExpansion

      public CheckstyleExecutorRequest setPropertyExpansion(String propertyExpansion)

    • getHeaderLocation

      public String getHeaderLocation()

    • setHeaderLocation

      public CheckstyleExecutorRequest setHeaderLocation(String headerLocation)

    • getCacheFile

      public String getCacheFile()

    • setCacheFile

      public CheckstyleExecutorRequest setCacheFile(String cacheFile)

    • getSuppressionsFileExpression

      public String getSuppressionsFileExpression()

    • setSuppressionsFileExpression

      public CheckstyleExecutorRequest setSuppressionsFileExpression(String suppressionsFileExpression)

    • getEncoding

      public String getEncoding()

    • setEncoding

      public CheckstyleExecutorRequest setEncoding(String encoding)

    • getPropertiesLocation

      public String getPropertiesLocation()

    • setPropertiesLocation

      public CheckstyleExecutorRequest setPropertiesLocation(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 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.