Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.plugin.checkstyle.exec
Class CheckstyleExecutorRequest

java.lang.Object
  extended by org.apache.maven.plugin.checkstyle.exec.CheckstyleExecutorRequest

public class CheckstyleExecutorRequest
extends Object

Since:
2.5
Version:
$Id: CheckstyleExecutorRequest.html 938569 2015-02-01 15:55:48Z dennisl $
Author:
Olivier Lamy

Constructor Summary
CheckstyleExecutorRequest()
          Constructor.
 
Method Summary
 String getCacheFile()
           
 String getConfigLocation()
           
 List<Artifact> getConfigurationArtifacts()
          Returns a list of artifacts, which may contain the checkstyle configuration.
 DefaultLogger getConsoleListener()
           
 String getEncoding()
           
 String getExcludes()
           
 String getHeaderLocation()
           
 String getIncludes()
          Returns the includes parameter.
 List<Artifact> getLicenseArtifacts()
          Returns a list of license artifacts, which may contain the license.
 AuditListener getListener()
           
 MavenProject getProject()
           
 String getPropertiesLocation()
           
 String getPropertyExpansion()
           
 List<MavenProject> getReactorProjects()
          Returns the list of reactor projects.
 String getResourceExcludes()
           
 String getResourceIncludes()
           
 List<Resource> getResources()
           
 Collection<File> getSourceDirectories()
           
 File getSourceDirectory()
          Deprecated. instead use getSourceDirectories()
 ByteArrayOutputStream getStringOutputStream()
           
 String getSuppressionsFileExpression()
           
 String getSuppressionsLocation()
           
 List<Resource> getTestResources()
           
 Collection<File> getTestSourceDirectories()
           
 File getTestSourceDirectory()
          Deprecated. instead use getTestSourceDirectories()
 boolean isAggregate()
          Returns true if the report is aggregated.
 boolean isConsoleOutput()
           
 boolean isFailsOnError()
           
 boolean isIncludeResources()
           
 boolean isIncludeTestResources()
           
 boolean isIncludeTestSourceDirectory()
           
 CheckstyleExecutorRequest setAggregate(boolean pAggregate)
          Sets the aggregate parameter.
 CheckstyleExecutorRequest setCacheFile(String cacheFile)
           
 CheckstyleExecutorRequest setConfigLocation(String configLocation)
           
 CheckstyleExecutorRequest setConfigurationArtifacts(List<Artifact> configArtifacts)
          Sets a list of artifacts, which may contain the checkstyle configuration.
 CheckstyleExecutorRequest setConsoleListener(DefaultLogger defaultLogger)
           
 CheckstyleExecutorRequest setConsoleOutput(boolean consoleOutput)
           
 CheckstyleExecutorRequest setEncoding(String encoding)
           
 CheckstyleExecutorRequest setExcludes(String excludes)
           
 CheckstyleExecutorRequest setFailsOnError(boolean failsOnError)
           
 CheckstyleExecutorRequest setHeaderLocation(String headerLocation)
           
 CheckstyleExecutorRequest setIncludeResources(boolean includeResources)
           
 CheckstyleExecutorRequest setIncludes(String includes)
           
 CheckstyleExecutorRequest setIncludeTestResources(boolean includeTestResources)
           
 CheckstyleExecutorRequest setIncludeTestSourceDirectory(boolean includeTestSourceDirectory)
           
 CheckstyleExecutorRequest setLicenseArtifacts(List<Artifact> licenseArtifacts)
          Sets a list of license artifacts, which may contain the license.
 CheckstyleExecutorRequest setListener(AuditListener listener)
           
 CheckstyleExecutorRequest setProject(MavenProject project)
           
 void setPropertiesLocation(String propertiesLocation)
           
 CheckstyleExecutorRequest setPropertyExpansion(String propertyExpansion)
           
 CheckstyleExecutorRequest setReactorProjects(List<MavenProject> pReactorProjects)
          Sets the list of reactor projects.
 CheckstyleExecutorRequest setResourceExcludes(String resourceExcludes)
           
 CheckstyleExecutorRequest setResourceIncludes(String resourceIncludes)
           
 CheckstyleExecutorRequest setResources(List<Resource> resources)
           
 CheckstyleExecutorRequest setSourceDirectories(Collection<File> sourceDirectories)
           
 CheckstyleExecutorRequest setSourceDirectory(File sourceDirectory)
          Deprecated. instead use setSourceDirectories(Collection)
 CheckstyleExecutorRequest setStringOutputStream(ByteArrayOutputStream stringOutputStream)
           
 CheckstyleExecutorRequest setSuppressionsFileExpression(String suppressionsFileExpression)
           
 CheckstyleExecutorRequest setSuppressionsLocation(String suppressionsLocation)
           
 CheckstyleExecutorRequest setTestResources(List<Resource> testResources)
           
 CheckstyleExecutorRequest setTestSourceDirectories(Collection<File> testSourceDirectories)
           
 CheckstyleExecutorRequest setTestSourceDirectory(File testSourceDirectory)
          Deprecated. instead use setTestSourceDirectories(Collection)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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 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 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.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2005–2015 The Apache Software Foundation. All rights reserved.