xdoclet.ejb.tags
Class MdbTagsHandler

java.lang.Object
  |
  +--xdoclet.template.TemplateTagHandler
        |
        +--xdoclet.XDocletTagSupport
              |
              +--xdoclet.ejb.tags.EjbTagsHandler
                    |
                    +--xdoclet.ejb.tags.MdbTagsHandler

public class MdbTagsHandler

extends EjbTagsHandler

Version:

$Revision: 1.2 $

Author:

Ara Abrahamian (ara_e@email.com)

Fields inherited from class xdoclet.ejb.tags.EjbTagsHandler

LOCAL_SUFFIX

Fields inherited from class xdoclet.XDocletTagSupport

FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER

Constructor Summary

MdbTagsHandler()

Method Summary

void	forAllMDBeans(java.lang.String template) Evaluates the body block for each EJBean derived from MessageDrivenBean.
static java.lang.String	getMessageDrivenClassFor(com.sun.javadoc.ClassDoc clazz)
void	ifMessageDriven(java.lang.String template) Evaluate the body block if current class is of a message driven bean type.
static boolean	isMessageDriven(com.sun.javadoc.ClassDoc clazz) Returns true if clazz is a messgae-driven bean, false otherwise.
java.lang.String	messageDrivenClass() Returns the name of message-driven bean class.

Methods inherited from class xdoclet.ejb.tags.EjbTagsHandler

beanType, choosePackage, concreteFullClassName, ejbExternalRefName, ejbName, ejbRefName, extendsFromFor, forAllBeans, getDependentClassFor, getDependentClassTagName, getEjbIdFor, getEjbNameFor, getEjbSpec, getShortEjbNameFor, hasPermission, hasTransaction, id, ifIsAConcreteEJBean, ifLocalEjb, ifNotLocalEjb, ifNotRemoteEjb, ifRemoteEjb, isAConcreteEJBean, isEjb, isLocalEjb, isOnlyLocalEjb, isOnlyRemoteEjb, isRemoteEjb, prefixWithEjbSlash, shortEjbName, shouldTraverseSuperclassForDependentClass, symbolicClassName

Methods inherited from class xdoclet.XDocletTagSupport

getClassTagValue, getClassTagValue, getConstructorTagValue, getCurrentClass, getCurrentConstructor, getCurrentField, getCurrentMethod, getCurrentPackage, getCurrentTag, getDocletContext, getFieldTagValue, getFieldTagValue, getMethodTagValue, getMethodTagValue, getParameterValue, getParameterValue, getTagValue, getTagValue, getTagValue, invalidParamValueFound, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, parsePropertyString, popCurrentClass, pushCurrentClass, replaceProperties, setCurrentClass, setCurrentConstructor, setCurrentField, setCurrentMethod, setCurrentPackage, setCurrentTag, tokenizeValue

Methods inherited from class xdoclet.template.TemplateTagHandler

generate, getContext, getEngine, getParser, setContext, setEngine, setParser

Methods inherited from class java.lang.Object

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

Constructor Detail

MdbTagsHandler

public MdbTagsHandler()

Method Detail

forAllMDBeans

public void forAllMDBeans(java.lang.String template)
                   throws XDocletException

Evaluates the body block for each EJBean derived from MessageDrivenBean.

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

See Also:

isMessageDriven(com.sun.javadoc.ClassDoc)

ifMessageDriven

public void ifMessageDriven(java.lang.String template)
                     throws XDocletException

Evaluate the body block if current class is of a message driven bean type.

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

messageDrivenClass

public java.lang.String messageDrivenClass()
                                    throws XDocletException

Returns the name of message-driven bean class.

Returns:

The name of generated message-driven bean class.

Throws:

XDocletException - Description of Exception

isMessageDriven

public static boolean isMessageDriven(com.sun.javadoc.ClassDoc clazz)
                               throws XDocletException

Returns true if clazz is a messgae-driven bean, false otherwise.

Parameters:

clazz - Description of Parameter

Returns:

The MessageDriven value

Throws:

XDocletException - Description of Exception

getMessageDrivenClassFor

public static java.lang.String getMessageDrivenClassFor(com.sun.javadoc.ClassDoc clazz)