org.jmlspecs.ant.tasks
Class DocTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.jmlspecs.ant.tasks.AbstractFileSetTask
              org.jmlspecs.ant.tasks.CommonOptionsTask
                  org.jmlspecs.ant.tasks.DocTask

public class DocTask

extends CommonOptionsTask

An Ant task to run jmldoc.

Version:

$Revision: 1.2 $

Author:

Marko van Dooren

Class Specifications

Specifications inherited from class AbstractFileSetTask

private invariant !this._filesets.contains(null); private invariant ( \forall java.lang.Object o; this._filesets.contains(o); o instanceof org.apache.tools.ant.types.FileSet);

Specifications inherited from class Object

represents objectState <- org.jmlspecs.lang.JMLDataGroup.IT; public represents _getClass <- \typeof(this);

Nested Class Summary
static class	DocTask.Package

 

Nested classes inherited from class org.jmlspecs.ant.tasks.AbstractFileSetTask

AbstractFileSetTask.FileSetVisitor

 

Model Field Summary

 

Model fields inherited from class java.lang.Object

_getClass, objectState, theString

 

Ghost Field Summary

 

Ghost fields inherited from class java.lang.Object

objectTimesFinalized, owner

 

Field Summary
private  ArrayList	_names

 

Fields inherited from class org.jmlspecs.ant.tasks.CommonOptionsTask

 

Fields inherited from class org.jmlspecs.ant.tasks.AbstractFileSetTask

 

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

DocTask()

 

Model Method Summary

 

Model methods inherited from class java.lang.Object

hashValue

 

Method Summary
void	addConfiguredPackage(DocTask.Package pack)
void	execute()           Check all the files in the filesets.
List	getFilesAndDirectories()           Return a list of the files and directories needed for running this tool.
static void	main(String[] args)

 

Methods inherited from class org.jmlspecs.ant.tasks.CommonOptionsTask

getArguments, getClasspath, getDestination, getRecursive, getSourcepath, getToolSpecificOptions, getVerbose, setClasspath, setDestination, setRecursive, setSourcepath, setVerbose

 

Methods inherited from class org.jmlspecs.ant.tasks.AbstractFileSetTask

addFileset, getFileSets

 

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

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, 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

_names

private ArrayList _names

DocTask

public DocTask()

Specifications:

ensures this.getVerbose() == false;

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Check all the files in the filesets.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

getFilesAndDirectories

public List getFilesAndDirectories()

Return a list of the files and directories needed for running this tool.

Overrides:

getFilesAndDirectories in class CommonOptionsTask

Specifications: pure non_null

Specifications inherited from overridden method in class CommonOptionsTask:
       non_null

addConfiguredPackage

public void addConfiguredPackage(DocTask.Package pack)

main

public static void main(String[] args)