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

## com.nokia.ant.taskdefs
Class AntLintTask

    java.lang.Object
      org.apache.tools.ant.ProjectComponent
          org.apache.tools.ant.Task
              com.nokia.ant.taskdefs.AntLintTask

All Implemented Interfaces:
  java.lang.Cloneable

    public class AntLintTask

extends org.apache.tools.ant.Task

AntLint Task. This task checks for common coding conventions and errors in Ant XML script files.

The current checks include:

- Macro names.
- Preset def names.
- Target names.
- Property names and Indentation.
- Project names.
- Project description is present.
- Ant file names.
- runtarget calls a target that has dependencies.
- antcall is used with no param elements and calls a target with no dependencies (could use runtarget instead).

Checks to be added:

- Help target is defined.
- Optional to thrown warnings about deprecated targets (rename, copydir, copyfile).

Field Summary

Fields inherited from class org.apache.tools.ant.Task
`target, taskName, taskType, wrapper`

Fields inherited from class org.apache.tools.ant.ProjectComponent
`description, location, project`

Constructor Summary
`AntLintTask()` AntLintTask Constructor

Method Summary
`void` | `addFileset(org.apache.tools.ant.types.FileSet set)` Add a set of files to copy.
`void` | `execute()`
`void` | `getConfiguration()`
`void` | `setConfigFile(java.lang.String configurationPath)` Set the path of the configuration file to use.
`void` | `treeWalk(org.dom4j.Document document)`
`void` | `treeWalk(org.dom4j.Element element)`

Methods inherited from class org.apache.tools.ant.Task
`bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType`

Methods inherited from class org.apache.tools.ant.ProjectComponent
`clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### AntLintTask

    public AntLintTask()

  AntLintTask Constructor

Method Detail

### addFileset

    public void addFileset(org.apache.tools.ant.types.FileSet set)

  Add a set of files to copy.

  Parameters:
    `set` - a set of files to AntLintTask.

### setConfigFile

    public void setConfigFile(java.lang.String configurationPath)

  Set the path of the configuration file to use.

  Parameters:
    `configurationPath` - path to config file

### execute

    public final void execute()

  Overrides:
    `execute` in class `org.apache.tools.ant.Task`

### treeWalk

    public final void treeWalk(org.dom4j.Document document)

### treeWalk

    public final void treeWalk(org.dom4j.Element element)

### getConfiguration

    public final void getConfiguration()

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