xdoclet.modules.ejb

Class EjbDocletTask

Implemented Interfaces:
DynamicConfigurator
Known Direct Subclasses:
EjbDocletTask

public class EjbDocletTask
extends xdoclet.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 $
Authors:
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

Method Summary

String
getEjbClassNameSuffix()
Gets the EjbClassNameSuffix attribute of the EjbDocletTask object
String
getEjbSpec()
Gets the EjbSpec attribute of the EjbDocletTask object
void
setEjbClassNameSuffix(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()

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, setExcludePackageNames, setExcludedTags, setForce, setMergeDir, setPackageNames, setPackageSubstitutions, setVerbose, start, validateOptions, validateSubTasks

Method Details

getEjbClassNameSuffix

public String getEjbClassNameSuffix()
Gets the EjbClassNameSuffix attribute of the EjbDocletTask object
Returns:
The EjbClassNameSuffix value

getEjbSpec

public String getEjbSpec()
Gets the EjbSpec attribute of the EjbDocletTask object
Returns:
The EjbSpec value

setEjbClassNameSuffix

public void setEjbClassNameSuffix(String ejbClassNameSuffix)
Parameters:
ejbClassNameSuffix -
ant.not-required
"No, Default is 'Bean,EJB,Ejb'"

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'"

validateOptions

protected void validateOptions()
            throws BuildException
Overrides:
validateOptions in interface xdoclet.DocletTask