XDoclet Overview News and Status Download/Installation Using XDoclet Best Practices FAQ License Ant Task Reference <ejbdoclet .. /> <webdoclet .. /> <hibernatedoclet .. /> <jdodoclet .. /> <jmxdoclet .. /> <doclet .. /> <documentdoclet .. /> Tag Reference apache (@soap @struts) bea (@weblogic) caucho (@resin) ejb (@ejb @dao) exolab (@castor) hp (@hpas) hibernate (@hibernate) ibm (@websphere) java (@javabean) jboss (@jboss) jdo (@jdo) jmx (@jmx) macromedia (@jrun) mvcsoft (@mvcsoft) mx4j (@mx4j) objectweb (@jonas) orion (@orion) pramati (@pramati) sybase (@easerver) web (@web @jsp) webwork (@webwork) xdoclet (@xdoclet @doc) Feature Documentation Using Value Objects Advanced Maven Plug-in Merge Points Log4J Configuration IDE Integration Migration from EJBDoclet Ant 1.5 Troubleshooting Community Feedback Resources Tools Developer Resources Developer Guide Architecture Branches and Tags CVS Directory Layout XDoclet 2.0 Design Planning Development Reference Javadoc (API) Template Language (*.xdt) Todo List Project Documentation Front Page Project Info Project Reports Development Process | ### ejbdoclet A task that executes various EJB-specific sub-tasks. #### Attributes
Attribute | Description | Required
--- | --- | ---
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. | No, Default is "Bean,EJB,Ejb"
ejbSpec | The version of EJB spec ejbdoclet should adhere, currently "1.1" and "2.0" defined. If, for example, "2.0" specified, then ejbdoclet will generate EJB 2.0-compatible ejb-jar.xml file. | No. Default is "2.0"
addedTags | Add some JavaDoc tags (or comments) to the generated classes. A special case @ xdoclet-generated. If this is included, ejbdoclet will not consider the file if it is by error in the fileset of the ejbdoclet task. | No.
destDir | Destination directory for output files | No.
excludedTags | Specify tags that should not be automatically written to output files. The normal behaviour is to include all @ tags from the source file to the output files. This may cause trouble if you use cvs-like tag like $Revision: 1.5 $ that will be overwritten at each build and causes a difference for CVS even if the code himself is not changed. Example: excludedtags="@ version" For excluded tags, ejbdoclet will generate an hardcoded tag. Example: @ version XDOCLET 1.0 | No.
force | Specify if the generation of files should be forced. In normal cases, the timestamp of generated file is checked against the timestamps of the class (and its super classes) we generate from. When this timestamp checking should be bypassed (for example after the installtion of a new xdoclet version) then the user should force the regeneration. The easiest way is to run the Ant build file with a parameter "-Dxdoclet.force=true" and add the option "force=${xdoclet.force}" to the doclet call. | No.
mergeDir | Directory where subtasks will look for files to be merged with generated files. | No, but should be set if you want to use the merge feature.
verbose | Sets the Verbose attribute of the DocletTask object. | No.
#### Nested Elements
Element | Description
--- | ---
apachesoap |
borland |
castormapping | Generates mapping.xml deployment descriptor.
configParam | Describe the method
dao |
dataobject | Creates "data objects" for Entity EJBs.
deploymentdescriptor |
easerver | Generates configuration files for EJB jars in EAServer 4.1+
entitybmp | Creates "entity bean classes" for BMP entity EJBs.
entitycmp |
entityfacade |
entitypk | Generates primary key classes for entity EJBs.
fileset | Ant's definition. To define the files to parse.
homeinterface | Generates remote home interfaces for EJBs.
hpas | Creates hp-ejb-jar.xml deployment descriptor for HPAS.
jboss | Creates jboss-xml and jaws.xml deployment descriptors for JBoss.
jonas | Generates the deployment descriptor for JOnAS.
jrun |
localhomeinterface | Generates local home interfaces for EJBs.
localinterface | Generates local interfaces for EJBs.
mvcsoft | Generates MVCSoft's xml.
orion | Generates Orion's orion-ejb-jar.xml.
packageSubstitution | Substitutes the package of the generated files.
pramati | Generates Pramati deployment files
remotefacade | this subtask is stage 2 of remote facade generation.
remoteinterface | Generates remote interfaces for EJBs.
resin-ejb-xml | Subtask for generation of resin-ejb.
session |
strutsform | Generates a Struts ActionForm, based on an entity EJB.
subTask |
template | Describe the method
utilobject |
valueobject | Creates "value objects" for Entity EJBs.
weblogic | This task can generate deployment descriptors for WLS 6.0 and WLS 6.1.
websphere | This is a JavaDoc doclet plugin that can be used to generate EJB-related files from just one or a set of EJB bean source files that uses custom EJBDoclet JavaDoc tags.
xmlTemplate | Describe the method