|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.gradle.api.internal.AbstractTask org.gradle.api.DefaultTask org.gradle.api.internal.ConventionTask org.gradle.api.tasks.SourceTask org.gradle.api.plugins.quality.Checkstyle
public class Checkstyle
Runs Checkstyle against some source files.
Field Summary |
---|
Fields inherited from interface org.gradle.api.Task |
---|
TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_NAME, TASK_OVERWRITE, TASK_TYPE |
Constructor Summary | |
---|---|
Checkstyle()
|
Method Summary | |
---|---|
void |
check()
|
FileCollection |
getClasspath()
Returns the classpath containing the compiled classes for the source files to be inspected. |
File |
getConfigFile()
Returns the Checkstyle configuration file to use. |
Map<String,Object> |
getProperties()
Returns the properties available for use in the configuration file. |
File |
getResultFile()
Returns the file to generate the XML results to. |
boolean |
isIgnoreFailures()
Specifies whether the build should break when the verifications performed by this task fail. |
void |
setClasspath(FileCollection classpath)
Specified the classpath containing the compiled classes for the source file to be inspected. |
void |
setConfigFile(File configFile)
Specifies the Checkstyle configuration file to use. |
Checkstyle |
setIgnoreFailures(boolean ignoreFailures)
Specifies whether the build should break when the verifications performed by this task fail. |
void |
setProperties(Map<String,Object> properties)
|
void |
setResultFile(File resultFile)
Specifies the file to generate the XML results to. |
Methods inherited from class org.gradle.api.tasks.SourceTask |
---|
exclude, exclude, exclude, exclude, getDefaultSource, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source |
Methods inherited from class org.gradle.api.internal.ConventionTask |
---|
conventionMapping, getConventionMapping, setConventionMapping |
Methods inherited from class org.gradle.api.internal.AbstractTask |
---|
captureStandardOutput, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, disableStandardOutputCapture, doFirst, doFirst, doLast, doLast, equals, execute, getActions, getAdditionalProperties, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuter, getGroup, getInputs, getLogger, getLogging, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getStandardOutputCapture, getState, getTaskDependencies, getTemporaryDir, hashCode, hasProperty, injectIntoNewInstance, isEnabled, leftShift, onlyIf, onlyIf, property, setActions, setConvention, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setGroup, setName, setOnlyIf, setOnlyIf, setProject, setProperty, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Checkstyle()
Method Detail |
---|
public void check()
public File getConfigFile()
public void setConfigFile(File configFile)
configFile
- The configuration file. Must not be null.public File getResultFile()
public void setResultFile(File resultFile)
resultFile
- The result XML file. Must not be null.public FileCollection getClasspath()
public void setClasspath(FileCollection classpath)
classpath
- The classpath. Must not be null.public Map<String,Object> getProperties()
public void setProperties(Map<String,Object> properties)
public boolean isIgnoreFailures()
isIgnoreFailures
in interface VerificationTask
public Checkstyle setIgnoreFailures(boolean ignoreFailures)
setIgnoreFailures
in interface VerificationTask
ignoreFailures
- false to break the build on failure, true to ignore the failures. The default is false.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |