xdoclet.modules.ejb.entity

Class BmpTagsHandler


public class BmpTagsHandler
extends EntityTagsHandler

Version:
$Revision: 1.8 $
Author:
Ara Abrahamian (ara_e@email.com)
xdoclet.taghandler
namespace = "EjbBmp"
created
Oct 16, 2001

Method Summary

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

Method Details

entityBmpClass

public String entityBmpClass()
            throws xdoclet.XDocletException
Returns the name of generated BMP class.
Returns:
The name of generated BMP class.
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"

forAllBmpEntityBeans

public void forAllBmpEntityBeans(String template)
            throws xdoclet.XDocletException
Evaluates the body block for each EJBean derived from EntityBean which is BMP.
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException -
See Also:
isEntityBmp(xjavadoc.XClass)
doc.tag
type = "block"

getEntityBmpClassFor

public static String getEntityBmpClassFor(XClass clazz)
            throws xdoclet.XDocletException
Gets the EntityBmpClassFor attribute of the BmpTagsHandler class
Parameters:
clazz - Describe what the parameter does
Returns:
The EntityBmpClassFor value
Throws:
xdoclet.XDocletException -

getEntityBmpClassPattern

protected static String getEntityBmpClassPattern()
Gets the EntityBmpClassPattern attribute of the BmpTagsHandler class
Returns:
The EntityBmpClassPattern value

ifEntityIsBmp

public void ifEntityIsBmp(String template)
            throws xdoclet.XDocletException
Evaluates the body block if current class is an BMP entity bean.
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

ifUseSoftLocking

public void ifUseSoftLocking(String template)
            throws xdoclet.XDocletException
Evaluates the body block if ejb:use-soft-locking is set for current class.
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException -
See Also:
useSoftLocking(xjavadoc.XClass)
doc.tag
type = "block"

isEntityBmp

public static boolean isEntityBmp(XClass clazz)
            throws xdoclet.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:
xdoclet.XDocletException -

useSoftLocking

public static boolean useSoftLocking(XClass clazz)
Returns true if clazz has ejb:use-soft-locking tag, false otherwise.
Parameters:
clazz - Description of Parameter
Returns:
Description of the Returned Value