xdoclet.ejb.tags
Class EntityTagsHandler

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

Direct Known Subclasses:

BmpTagsHandler, CmpTagsHandler

public class EntityTagsHandler

extends EjbTagsHandler

Version:

$Revision: 1.8 $

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

EntityTagsHandler()

Method Summary

void	forAllEntityBeans(java.lang.String template) Evaluates the body block for each EJBean derived from EntityBean.
void	ifEntity(java.lang.String template) Evaluate the body block if current class is of an entity type.
static boolean	isEntity(com.sun.javadoc.ClassDoc clazz) Returns true if clazz is an entity bean, false otherwise.
java.lang.String	persistenceType() Returns the persistent type of current bean.
java.lang.String	reentrant() Returns True if ejb:bean reentrant is true, False otherwise.

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

EntityTagsHandler

public EntityTagsHandler()

Method Detail

isEntity

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

Returns true if clazz is an entity bean, false otherwise.

Parameters:

clazz - Description of Parameter

Returns:

The Entity value

Throws:

XDocletException - Description of Exception

ifEntity

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

Evaluate the body block if current class is of an entity type.

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

See Also:

isEntity(com.sun.javadoc.ClassDoc)

persistenceType

public java.lang.String persistenceType()
                                 throws XDocletException

Returns the persistent type of current bean.

Returns:

"Container" or "Bean".

Throws:

XDocletException - Description of Exception

See Also:

CmpTagsHandler.isEntityCmp(com.sun.javadoc.ClassDoc), BmpTagsHandler.isEntityBmp(com.sun.javadoc.ClassDoc)

forAllEntityBeans

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

Evaluates the body block for each EJBean derived from EntityBean.

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

See Also:

isEntity(com.sun.javadoc.ClassDoc)

reentrant

public java.lang.String reentrant()
                           throws XDocletException

Returns True if ejb:bean reentrant is true, False otherwise. It does the case conversion trick from true to True and false to False.

Returns:

Description of the Returned Value

Throws:

XDocletException - Description of Exception

See Also:

isEntity(com.sun.javadoc.ClassDoc)