xdoclet.modules.ejb

Class 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)

UNKNOWN: April 30, 2001 name = "ejbdoclet" display-name = "EJB Task"

Nested Class Summary
static classEjbDocletTask.EjbSpecVersion
Method Summary
StringgetEjbClassNameSuffix()
Gets the EjbClassNameSuffix attribute of the EjbDocletTask object
StringgetEjbSpec()
Gets the EjbSpec attribute of the EjbDocletTask object
voidsetEjbClassNameSuffix(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.
voidsetEjbSpec(EjbDocletTask.EjbSpecVersion ejbspec)
The version of EJB spec ejbdoclet should adhere, currently "1.1", "2.0" and "2.1" defined.
protected voidvalidateOptions()

Method Detail

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)
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

UNKNOWN: "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

UNKNOWN: "No. Default is '2.0'"

validateOptions

protected void validateOptions()