com.puppycrawl.tools.checkstyle

Class CheckStyleTask

public class CheckStyleTask extends Task

An implementation of a ANT task for calling checkstyle. See the documentation of the task for usage.

Author: Oliver Burn

Nested Class Summary
static classCheckStyleTask.Formatter
Details about a formatter to be used.
static classCheckStyleTask.FormatterType
Poor mans enumeration for the formatter types.
static classCheckStyleTask.Listener
Represents a custom listener.
static classCheckStyleTask.Property
Represents a property that consists of a key and value.
Method Summary
voidaddFileset(FileSet aFS)
Adds a set of files (nested fileset attribute).
voidaddFormatter(CheckStyleTask.Formatter aFormatter)
Add a formatter.
voidaddProperty(CheckStyleTask.Property aProperty)
Add an override property.
PathcreateClasspath()
voidexecute()
Actually checks the files specified.
protected AuditListener[]getListeners()
Return the list of listeners set in this task.
protected File[]scanFileSets()
returns the list of files (full path name) to process.
voidsetClasspath(Path aClasspath)
Set the class path.
voidsetClasspathRef(Reference aClasspathRef)
Set the class path from a reference defined elsewhere.
voidsetConfig(File aFile)
voidsetConfigURL(URL aURL)
voidsetFailOnViolation(boolean aFail)
voidsetFailureProperty(String aPropertyName)
Tells this task to set the named property to "true" when there is a violation.
voidsetFile(File aFile)
voidsetMaxErrors(int aMaxErrors)
Sets the maximum number of errors allowed.
voidsetMaxWarnings(int aMaxWarnings)
Sets the maximum number of warings allowed.
voidsetPackageNamesFile(File aFile)
voidsetProperties(File aProps)
Sets a properties file for use instead of individually setting them.

Method Detail

addFileset

public void addFileset(FileSet aFS)
Adds a set of files (nested fileset attribute).

Parameters: aFS the file set to add

addFormatter

public void addFormatter(CheckStyleTask.Formatter aFormatter)
Add a formatter.

Parameters: aFormatter the formatter to add for logging.

addProperty

public void addProperty(CheckStyleTask.Property aProperty)
Add an override property.

Parameters: aProperty the property to add

createClasspath

public Path createClasspath()

Returns: a created path for locating classes

execute

public void execute()
Actually checks the files specified. All errors are reported to System.out. Will fail if any errors occurred.

Throws: BuildException an error occurred

getListeners

protected AuditListener[] getListeners()
Return the list of listeners set in this task.

Returns: the list of listeners.

Throws: ClassNotFoundException if an error occurs InstantiationException if an error occurs IllegalAccessException if an error occurs IOException if an error occurs

scanFileSets

protected File[] scanFileSets()
returns the list of files (full path name) to process.

Returns: the list of files included via the filesets.

setClasspath

public void setClasspath(Path aClasspath)
Set the class path.

Parameters: aClasspath the path to locate classes

setClasspathRef

public void setClasspathRef(Reference aClasspathRef)
Set the class path from a reference defined elsewhere.

Parameters: aClasspathRef the reference to an instance defining the classpath

setConfig

public void setConfig(File aFile)

Parameters: aFile the configuration file to use

setConfigURL

public void setConfigURL(URL aURL)

Parameters: aURL the URL of the configuration to use

setFailOnViolation

public void setFailOnViolation(boolean aFail)

Parameters: aFail whether to fail if a violation is found

setFailureProperty

public void setFailureProperty(String aPropertyName)
Tells this task to set the named property to "true" when there is a violation.

Parameters: aPropertyName the name of the property to set in the event of an failure.

setFile

public void setFile(File aFile)

Parameters: aFile the file to be checked

setMaxErrors

public void setMaxErrors(int aMaxErrors)
Sets the maximum number of errors allowed. Default is 0.

Parameters: aMaxErrors the maximum number of errors allowed.

setMaxWarnings

public void setMaxWarnings(int aMaxWarnings)
Sets the maximum number of warings allowed. Default is {@link Integer#MAX_VALUE}.

Parameters: aMaxWarnings the maximum number of warnings allowed.

setPackageNamesFile

public void setPackageNamesFile(File aFile)

Parameters: aFile the package names file to use

setProperties

public void setProperties(File aProps)
Sets a properties file for use instead of individually setting them.

Parameters: aProps the properties File to use