Constructor Detail

• CheckstyleExecutorRequest

  public CheckstyleExecutorRequest()

  Constructor.

Method Detail

• 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 MavenProject getProject()

• setProject

  public CheckstyleExecutorRequest setProject(MavenProject project)

• getSuppressionsLocation

  public String getSuppressionsLocation()

• setSuppressionsLocation

  public CheckstyleExecutorRequest setSuppressionsLocation(String suppressionsLocation)

• isIncludeTestSourceDirectory

  public boolean isIncludeTestSourceDirectory()

• setIncludeTestSourceDirectory

  public CheckstyleExecutorRequest setIncludeTestSourceDirectory(boolean includeTestSourceDirectory)

• getTestSourceDirectory

  @Deprecated
  public File getTestSourceDirectory()

  Deprecated. instead use getTestSourceDirectories()

  Returns:

  first entry of testSourceDirectories, otherwise null

• setTestSourceDirectory

  @Deprecated
  public CheckstyleExecutorRequest setTestSourceDirectory(File testSourceDirectory)

  Deprecated. instead use setTestSourceDirectories(Collection)

  Parameters:

  testSourceDirectory - a single testSourceDirectory

  Returns:

  this request

• getTestSourceDirectories

  public Collection<File> getTestSourceDirectories()

• setTestSourceDirectories

  public CheckstyleExecutorRequest setTestSourceDirectories(Collection<File> testSourceDirectories)

• getSourceDirectory

  @Deprecated
  public File getSourceDirectory()

  Deprecated. instead use getSourceDirectories()

  Returns:

  first entry of sourceDirectories, otherwise null

• setSourceDirectory

  @Deprecated
  public CheckstyleExecutorRequest setSourceDirectory(File sourceDirectory)

  Deprecated. instead use setSourceDirectories(Collection)

  Parameters:

  sourceDirectory - a single sourceDirectory

  Returns:

  this request

• getSourceDirectories

  public Collection<File> getSourceDirectories()

• setSourceDirectories

  public CheckstyleExecutorRequest setSourceDirectories(Collection<File> sourceDirectories)

• getResources

  public List<Resource> getResources()

• setResources

  public CheckstyleExecutorRequest setResources(List<Resource> resources)

• getTestResources

  public List<Resource> getTestResources()

• setTestResources

  public CheckstyleExecutorRequest setTestResources(List<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 void 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<MavenProject> getReactorProjects()

  Returns the list of reactor projects.

  Returns:

  The reactor projects.

• setReactorProjects

  public CheckstyleExecutorRequest setReactorProjects(List<MavenProject> pReactorProjects)

  Sets the list of reactor projects.

  Parameters:

  pReactorProjects - The reactor projects.

  Returns:

  This object.

• getLicenseArtifacts

  public List<Artifact> getLicenseArtifacts()

  Returns a list of license artifacts, which may contain the license.

  Returns:

  the license artifacts

• setLicenseArtifacts

  public CheckstyleExecutorRequest setLicenseArtifacts(List<Artifact> licenseArtifacts)

  Sets a list of license artifacts, which may contain the license.

  Parameters:

  licenseArtifacts -

  Returns:

  This object.

• getConfigurationArtifacts

  public List<Artifact> getConfigurationArtifacts()

  Returns a list of artifacts, which may contain the checkstyle configuration.

  Returns:

  the license artifacts

• setConfigurationArtifacts

  public CheckstyleExecutorRequest setConfigurationArtifacts(List<Artifact> configArtifacts)

  Sets a list of artifacts, which may contain the checkstyle configuration.

  Parameters:

  configArtifacts -

  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.