|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gradle.api.internal.ConventionTask
org.gradle.api.tasks.SourceTask
org.gradle.api.plugins.quality.Checkstyle
public class Checkstyle extends SourceTask
Runs Checkstyle against some source files.
Method Summary | |
---|---|
void
|
check()
|
FileCollection
|
getClasspath()
Returns the classpath containing the compiled classes for the source files to be inspected. |
java.io.File
|
getConfigFile()
Returns the Checkstyle configuration file to use. |
java.util.Map
|
getProperties()
Returns the properties available for use in the configuration file. |
java.io.File
|
getResultFile()
Returns the file to generate the XML results to. |
boolean
|
isIgnoreFailures()
{@inheritDoc} |
void
|
setClasspath(FileCollection classpath)
Specified the classpath containing the compiled classes for the source file to be inspected. |
void
|
setConfigFile(java.io.File configFile)
Specifies the Checkstyle configuration file to use. |
Checkstyle
|
setIgnoreFailures(boolean ignoreFailures)
{@inheritDoc} |
void
|
setProperties(java.util.Map properties)
|
void
|
setResultFile(java.io.File resultFile)
Specifies the file to generate the XML results to. |
Methods inherited from class SourceTask | |
---|---|
exclude, exclude, exclude, exclude, getDefaultSource, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source |
Method Detail |
---|
@TaskAction public void check()
@InputFiles public FileCollection getClasspath()
@InputFile public java.io.File getConfigFile()
public java.util.Map getProperties()
@OutputFile public java.io.File getResultFile()
public boolean isIgnoreFailures()
public void setClasspath(FileCollection classpath)
classpath
- The classpath. Must not be null.
public void setConfigFile(java.io.File configFile)
configFile
- The configuration file. Must not be null.
public Checkstyle setIgnoreFailures(boolean ignoreFailures)
public void setProperties(java.util.Map properties)
public void setResultFile(java.io.File resultFile)
resultFile
- The result XML file. Must not be null.
Groovy Documentation