xdoclet.ejb.tags
Class BmpTagsHandler

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

public class BmpTagsHandler

extends EntityTagsHandler

Version:

$Revision: 1.9 $

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

BmpTagsHandler()

Method Summary

java.lang.String	entityBmpClass() Returns the name of generated BMP class.
void	forAllBmpEntityBeans(java.lang.String template) Evaluates the body block for each EJBean derived from EntityBean which is BMP.
static java.lang.String	getEntityBmpClassFor(com.sun.javadoc.ClassDoc clazz)
protected static java.lang.String	getEntityBmpClassPattern()
void	ifEntityIsBmp(java.lang.String template) Evaluates the body block if current class is an BMP entity bean.
void	ifUseSoftLocking(java.lang.String template) Evaluates the body block if ejb:use-soft-locking is set for current class.
static boolean	isEntityBmp(com.sun.javadoc.ClassDoc clazz) Returns true if clazz is an BMP entity bean, false otherwise.
static boolean	useSoftLocking(com.sun.javadoc.ClassDoc clazz) Returns true if clazz has ejb:use-soft-locking tag, false otherwise.

Methods inherited from class xdoclet.ejb.tags.EntityTagsHandler

forAllEntityBeans, ifEntity, isEntity, persistenceType, reentrant

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

BmpTagsHandler

public BmpTagsHandler()

Method Detail

getEntityBmpClassFor

public static java.lang.String getEntityBmpClassFor(com.sun.javadoc.ClassDoc clazz)
                                             throws XDocletException

isEntityBmp

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

Returns true if clazz is an BMP entity bean, false otherwise. Entity type is determined by looking at the ejb:bean's type parameter.

Parameters:

clazz - Description of Parameter

Returns:

The EntityBmp value

Throws:

XDocletException - Description of Exception

useSoftLocking

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

Returns true if clazz has ejb:use-soft-locking tag, false otherwise.

Parameters:

clazz - Description of Parameter

Returns:

Description of the Returned Value

Throws:

XDocletException - Description of Exception

getEntityBmpClassPattern

protected static java.lang.String getEntityBmpClassPattern()

entityBmpClass

public java.lang.String entityBmpClass()
                                throws XDocletException

Returns the name of generated BMP class.

Returns:

The name of generated BMP class.

Throws:

XDocletException - Description of Exception

ifEntityIsBmp

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

Evaluates the body block if current class is an BMP entity bean.

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

forAllBmpEntityBeans

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

Evaluates the body block for each EJBean derived from EntityBean which is BMP.

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

See Also:

isEntityBmp(com.sun.javadoc.ClassDoc)

ifUseSoftLocking

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

Evaluates the body block if ejb:use-soft-locking is set for current class.

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

See Also:

useSoftLocking(com.sun.javadoc.ClassDoc)