xdoclet.modules.ejb
Class EjbDocletTask

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.ejb.EjbDocletTask
All Implemented Interfaces:
java.lang.Cloneable, org.apache.tools.ant.DynamicAttribute, org.apache.tools.ant.DynamicConfigurator, org.apache.tools.ant.DynamicElement
Direct Known Subclasses:
EjbDocletTask

public class EjbDocletTask
extends DocletTask

This task executes various EJB-specific sub-tasks. Make sure to include the jar file containing Sun's javax.ejb.* classes on the taskdef's classpath.

Version:
$Revision: 1.13 $
Author:
Ara Abrahamian (ara_e@email.com), Christoph G. Jung (christoph.jung@infor.de)
ant.element
name = "ejbdoclet" display-name = "EJB Task"
created
April 30, 2001

Nested Class Summary
static class EjbDocletTask.EjbSpecVersion
           
 
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
EjbDocletTask()
           
 
Method Summary
 java.lang.String getEjbClassNameSuffix()
          Gets the EjbClassNameSuffix attribute of the EjbDocletTask object
 java.lang.String getEjbSpec()
          Gets the EjbSpec attribute of the EjbDocletTask object
 void setEjbClassNameSuffix(java.lang.String ejbClassNameSuffix)
          A comma-separated list of endings which should be removed from the bean class name to generate a bean's name if no name parameter is specified in the ejb.bean tag.
 void setEjbSpec(EjbDocletTask.EjbSpecVersion ejbspec)
          The version of EJB spec ejbdoclet should adhere, currently "1.1", "2.0" and "2.1" defined.
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

EjbDocletTask

public EjbDocletTask()
Method Detail

getEjbSpec

public java.lang.String getEjbSpec()
Gets the EjbSpec attribute of the EjbDocletTask object

Returns:
The EjbSpec value

getEjbClassNameSuffix

public java.lang.String getEjbClassNameSuffix()
Gets the EjbClassNameSuffix attribute of the EjbDocletTask object

Returns:
The EjbClassNameSuffix value

setEjbSpec

public void setEjbSpec(EjbDocletTask.EjbSpecVersion ejbspec)
The version of EJB spec ejbdoclet should adhere, currently "1.1", "2.0" and "2.1" defined. If, for example, "2.0" specified, then ejbdoclet will generate EJB 2.0-compatible ejb-jar.xml file.

Parameters:
ejbspec -
ant.not-required
"No. Default is '2.0'"

setEjbClassNameSuffix

public void setEjbClassNameSuffix(java.lang.String ejbClassNameSuffix)
A comma-separated list of endings which should be removed from the bean class name to generate a bean's name if no name parameter is specified in the ejb.bean tag.

Parameters:
ejbClassNameSuffix -
ant.not-required
"No, Default is 'Bean,EJB,Ejb'"

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/