net.dpml.tools.tasks
Class JavadocTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by net.dpml.tools.tasks.GenericTask
              extended by net.dpml.tools.tasks.ResourceTask
                  extended by net.dpml.tools.tasks.JavadocTask

public class JavadocTask
extends ResourceTask

Build the javadoc for a project.

Version:
1.2.0
Author:
Digital Product Meta Library

Nested Class Summary
static class JavadocTask.Group
          Defintion of a package group.
 class JavadocTask.Link
          Delcaration of a link.
 
Field Summary
static String JAVADOC_ACCESS_KEY
          Property key for declaration of an overriding access level.
static String JAVADOC_LINK_SOURCE_KEY
          Property key for declaration of the linksource option.
 
Fields inherited from class net.dpml.tools.tasks.GenericTask
ASC_EXT, GPG_EXE_KEY, MD5_EXT
 
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
JavadocTask()
           
 
Method Summary
 JavadocTask.Group createGroup()
          Create and add a new group to the javadoc defintion.
 JavadocTask.Link createLink()
          Create and add a new link to the javadoc run.
 void execute()
          Task execution.
 void init()
          Task initialization.
 void setAccess(Javadoc.AccessType access)
          Set the documentation access level.
 void setDest(File dir)
          Override the default destination.
 void setOverview(File overview)
          Set the javadoc overview file.
 void setTitle(String title)
          Set the javadoc title.
 
Methods inherited from class net.dpml.tools.tasks.ResourceTask
getResource, setKey, setRef
 
Methods inherited from class net.dpml.tools.tasks.GenericTask
asc, checksum, copy, deleteDir, getContext, getLibrary, isInitialized, mkDir
 
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

JAVADOC_ACCESS_KEY

public static final String JAVADOC_ACCESS_KEY
Property key for declaration of an overriding access level.

See Also:
Constant Field Values

JAVADOC_LINK_SOURCE_KEY

public static final String JAVADOC_LINK_SOURCE_KEY
Property key for declaration of the linksource option.

See Also:
Constant Field Values
Constructor Detail

JavadocTask

public JavadocTask()
Method Detail

init

public void init()
Task initialization.

Overrides:
init in class GenericTask

setTitle

public void setTitle(String title)
Set the javadoc title.

Parameters:
title - the title

setOverview

public void setOverview(File overview)
Set the javadoc overview file.

Parameters:
overview - the overview file

setDest

public void setDest(File dir)
Override the default destination.

Parameters:
dir - the destination directory

createLink

public JavadocTask.Link createLink()
Create and add a new link to the javadoc run.

Returns:
the new link

createGroup

public JavadocTask.Group createGroup()
Create and add a new group to the javadoc defintion.

Returns:
the new group

setAccess

public void setAccess(Javadoc.AccessType access)
Set the documentation access level.

Parameters:
access - the access level

execute

public void execute()
             throws BuildException
Task execution.

Overrides:
execute in class Task
Throws:
BuildException - if a build error occurs