xdoclet.modules.jdo
Class JdoDocletTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by xjavadoc.ant.XJavadocTask
              extended by xdoclet.DocletTask
                  extended by xdoclet.modules.jdo.JdoDocletTask
All Implemented Interfaces:
java.lang.Cloneable, org.apache.tools.ant.DynamicAttribute, org.apache.tools.ant.DynamicConfigurator, org.apache.tools.ant.DynamicElement

public class JdoDocletTask
extends DocletTask

This task that executes various JDO-specific sub-tasks.

Version:
$Revision: 1.5 $
Author:
Ludovic Claude (ludovicc@users.sourceforge.net), Marco Schulze (nlmarco@users.sourceforge.net) - added JDO 2.0 support (mainly changes in *.xdt)
ant.element
name = "jdodoclet" display-name = "JDO Task"
created
June 11, 20012

Nested Class Summary
static class JdoDocletTask.JdoSpecVersion
           
 
Field Summary
 
Fields inherited from class xdoclet.DocletTask
XDOCLET_VERSION
 
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
JdoDocletTask()
           
 
Method Summary
 java.lang.String getJdoSpec()
          Gets the JdoSpec attribute of the JdoDocletTask object
 void setJdoSpec(JdoDocletTask.JdoSpecVersion jdoSpec)
          Sets the jdo spec to use.
protected  void validateOptions()
          Called by superclass before start() is called
 
Methods inherited from class xdoclet.DocletTask
addConfigParam, addFileset, addPackageSubstitution, addSubTask, addTemplate, addXmlTemplate, checkClass, createDynamicElement, getAddedTags, getConfigParams, getConfigParams, getConfigParamsAsMap, getDestDir, getExcludedTags, getMergeDir, getPackageSubstitutions, getSubTaskName, getSubTasks, isForce, isVerbose, setAddedTags, setDestDir, setDynamicAttribute, setExcludedTags, setExcludePackageNames, setForce, setMergeDir, setPackageNames, setPackageSubstitutions, setVerbose, start, validateSubTasks
 
Methods inherited from class xjavadoc.ant.XJavadocTask
createIgnoredtag, execute, getClasspath, getXJavaDoc, setDocencoding, setEncoding, setIgnoredtags, setValidating
 
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

JdoDocletTask

public JdoDocletTask()
Method Detail

getJdoSpec

public java.lang.String getJdoSpec()
Gets the JdoSpec attribute of the JdoDocletTask object

Returns:
The JdoSpec value

setJdoSpec

public void setJdoSpec(JdoDocletTask.JdoSpecVersion jdoSpec)
Sets the jdo spec to use. Valid values are "1.0" and "2.0". Default is "1.0"

Parameters:
jdoSpec -

validateOptions

protected void validateOptions()
                        throws org.apache.tools.ant.BuildException
Description copied from class: DocletTask
Called by superclass before start() is called

Overrides:
validateOptions in class DocletTask
Throws:
org.apache.tools.ant.BuildException - Describe the exception

http://xdoclet.sourceforge.net/