xdoclet.ejb.vendor
Class WebSphereSubTask

java.lang.Object
  |
  +--xdoclet.DocletSupport
        |
        +--xdoclet.SubTask
              |
              +--xdoclet.TemplateSubTask
                    |
                    +--xdoclet.XmlSubTask
                          |
                          +--xdoclet.ejb.AbstractEjbDeploymentDescriptorSubTask
                                |
                                +--xdoclet.ejb.vendor.WebSphereSubTask

All Implemented Interfaces:

java.io.Serializable

public class WebSphereSubTask

extends AbstractEjbDeploymentDescriptorSubTask

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. In addition to the files generated by EJBDoclet, WebSphereDoclet will also generate WebSphere specific deployment XML files.

Version:

$Revision: 1.10 $

Author:

Minh Yie

See Also:

Serialized Form

Inner classes inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes

Field Summary

static java.lang.String

SUBTASK_NAME

Fields inherited from class xdoclet.XmlSubTask

useIds

Fields inherited from class xdoclet.DocletSupport

currentTag

Constructor Summary

WebSphereSubTask()

Method Summary

protected void	engineStarted()
void	execute() Called to start execution of the sub-task.
java.lang.String	getSubTaskName()

Methods inherited from class xdoclet.ejb.AbstractEjbDeploymentDescriptorSubTask

atLeastOneCmpEntityBeanExists

Methods inherited from class xdoclet.XmlSubTask

copyAttributesFrom, engineFinished, getDtdFileName, getPublicId, getSchema, getSystemId, getUseIds, getXmlencoding, isValidateXML, setDtdFileName, setPublicId, setSchema, setSystemId, setUseIds, setValidateXML, setXmlencoding, startProcess

Methods inherited from class xdoclet.TemplateSubTask

addPackageSubstitution, beanFile, generateForClass, getDestinationFile, getEngine, getExtent, getGeneratedFileName, getHavingClassTag, getOfType, getPackageSubstitutions, getParser, getSubTaskClassName, getTemplateURL, init, isGuessGenerationNeeded, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, matchesGenerationRules, setDestinationFile, setEngine, setExtent, setExtentValue, setGuessGenerationNeeded, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setParser, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, validateOptions

Methods inherited from class xdoclet.SubTask

addConfigParam, getConfigParams, getContext, getDestDir, getMergeDir, setDestDir, setMergeDir, setSubTaskName

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentConstructor, getCurrentField, getCurrentMethod, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentConstructor, setCurrentField, setCurrentMethod, setCurrentPackage, setCurrentTag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUBTASK_NAME

public static final java.lang.String SUBTASK_NAME

Constructor Detail

WebSphereSubTask

public WebSphereSubTask()

Method Detail

getSubTaskName

public java.lang.String getSubTaskName()

Overrides:

getSubTaskName in class TemplateSubTask

execute

public void execute()
             throws XDocletException

Description copied from class: SubTask

Called to start execution of the sub-task.

Overrides:

execute in class TemplateSubTask

Following copied from class: xdoclet.SubTask

Throws:

XDocletException - Description of Exception

engineStarted

protected void engineStarted()
                      throws XDocletException

Overrides:

engineStarted in class TemplateSubTask