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

org.gradle.api.plugins.quality
Class Checkstyle

java.lang.Object
  extended by org.gradle.api.internal.AbstractTask
      extended by org.gradle.api.DefaultTask
          extended by org.gradle.api.internal.ConventionTask
              extended by org.gradle.api.tasks.SourceTask
                  extended by org.gradle.api.plugins.quality.Checkstyle
All Implemented Interfaces:
Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Task, PatternFilterable, VerificationTask, org.gradle.util.Configurable<Task>
public class Checkstyle
extends SourceTask
implements VerificationTask

Runs Checkstyle against some source files.

Field Summary
 
Fields inherited from interface org.gradle.api.Task
TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, 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
addValidator, captureStandardOutput, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, disableStandardOutputCapture, doFirst, doFirst, doLast, doLast, 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, getValidators, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Checkstyle

public Checkstyle()
Method Detail

check

public void check()

getConfigFile

public File getConfigFile()
Returns the Checkstyle configuration file to use.

Returns:
The configuration file.

setConfigFile

public void setConfigFile(File configFile)
Specifies the Checkstyle configuration file to use.

Parameters:
configFile - The configuration file. Must not be null.

getResultFile

public File getResultFile()
Returns the file to generate the XML results to.

Returns:
The result XML file.

setResultFile

public void setResultFile(File resultFile)
Specifies the file to generate the XML results to.

Parameters:
resultFile - The result XML file. Must not be null.

getClasspath

public FileCollection getClasspath()
Returns the classpath containing the compiled classes for the source files to be inspected.

Returns:
The classpath.

setClasspath

public void setClasspath(FileCollection classpath)
Specified the classpath containing the compiled classes for the source file to be inspected.

Parameters:
classpath - The classpath. Must not be null.

getProperties

public Map<String,Object> getProperties()
Returns the properties available for use in the configuration file. These are substituted into the configuration file.

Returns:
The properties available in the configuration file. Returns an empty map when there are no such properties.

setProperties

public void setProperties(Map<String,Object> properties)

isIgnoreFailures

public boolean isIgnoreFailures()
Specifies whether the build should break when the verifications performed by this task fail.

Specified by:
isIgnoreFailures in interface VerificationTask
Returns:
false, when the build should break on failure, true when the failures should be ignored.

setIgnoreFailures

public Checkstyle setIgnoreFailures(boolean ignoreFailures)
Specifies whether the build should break when the verifications performed by this task fail.

Specified by:
setIgnoreFailures in interface VerificationTask
Parameters:
ignoreFailures - false to break the build on failure, true to ignore the failures. The default is false.
Returns:
this
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD