net.dpml.tools.checkstyle
Class CheckstyleTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          com.puppycrawl.tools.checkstyle.CheckStyleTask
              net.dpml.tools.checkstyle.CheckstyleTask

public class CheckstyleTask
extends CheckStyleTask

The checkstyle task handes the establishment of a classic checkstyle task with automatic resolution of source directories. Typical usage is within a build file that aggregates results for a module.

Version:

1.1.3

Author:

Digital Product Meta Library

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.CheckStyleTask

CheckStyleTask.Formatter, CheckStyleTask.FormatterType, CheckStyleTask.Listener, CheckStyleTask.Property

Field Summary

static String	FORMAT_KEY The format property key.
static String	FORMAT_VALUE The default format value.

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

CheckstyleTask()

Method Summary

void	execute() Execute the checkstyle check.
void	init() Task initialization.
void	setImplicit(boolean flag) Set the implicit inclusion of the current resource (and potentially the resources children if the resource is a module).

Methods inherited from class com.puppycrawl.tools.checkstyle.CheckStyleTask

addFileset, addFormatter, addProperty, createClasspath, getListeners, scanFileSets, setClasspath, setClasspathRef, setConfig, setConfigURL, setFailOnViolation, setFailureProperty, setFile, setMaxErrors, setMaxWarnings, setPackageNamesFile, setProperties

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FORMAT_KEY

public static final String FORMAT_KEY

The format property key.

See Also:

Constant Field Values

FORMAT_VALUE

public static final String FORMAT_VALUE

The default format value.

See Also:

Constant Field Values

Constructor Detail

CheckstyleTask

public CheckstyleTask()

Method Detail

setImplicit

public void setImplicit(boolean flag)

Set the implicit inclusion of the current resource (and potentially the resources children if the resource is a module). If implicit file inclusion is disabled then resources must be declared using an explicit fileset.

Parameters:

flag - false if implicit inclusion is to be disabled

init

public void init()

Task initialization.

Overrides:

init in class Task

execute

public void execute()

Execute the checkstyle check.

Overrides:

execute in class CheckStyleTask