Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

xdoclet.modules.ejb.mdb

Class MdbTagsHandler

public class MdbTagsHandler
extends EjbTagsHandler
Version:
$Revision: 1.16 $
Author:
Ara Abrahamian (ara_e@email.com)
xdoclet.taghandler
namespace = "EjbMdb"
created
Oct 16, 2001

Method Summary

String
destinationDescription()
Returns the description of the current message destination
String
destinationDisplayName()
Returns the display-name of the current message destination
String
destinationJndiName()
Returns the jndi-name of the current message destination
String
destinationName()
Returns the name of the current message destination
void
forAllDestinations(String template)
Evaluates the body block for each ejb:message-destination defined in class level
void
forAllMDBeans(String template)
Evaluates the body block for each EJBean derived from MessageDrivenBean.
static String
getMessageDrivenClassFor(XClass clazz)
Gets the MdbClassFor attribute of the MdbTagsHandler class
protected static String
getMessageDrivenClassPattern()
Gets the MdbClassPattern attribute of the MdbTagsHandler class
void
ifDestinationHasDescription(String template)
Evaluate the body block if the current message destination has a descrition
void
ifDestinationHasDisplayName(String template)
Evaluate the body block if the current message destination has a display-name
void
ifDestinationHasJndiName(String template)
Evaluate the body block if the current message destination has a jndi-name
void
ifHasActivationConfig(String template, Properties attributes)
Evaluate the body block if the current class has a activation config
void
ifMessageDriven(String template)
Evaluate the body block if current class is of a message driven bean type.
void
ifNotMessageDriven(String template)
Evaluate the body block if current class is not of a message driven bean type.
static boolean
isMessageDriven(XClass clazz)
Returns true if clazz is a message-driven bean, false otherwise.
String
mdbClass()
Returns the name of message-driven bean class.
String
messageDrivenClass()
Returns the name of message-driven bean class.

Method Details

destinationDescription

public String destinationDescription()
            throws xdoclet.XDocletException
Returns the description of the current message destination
Returns:
Current message destination's description
Throws:
xdoclet.XDocletException -
See Also:
forAllDestinations(java.lang.String)
doc.tag
type = "content"

destinationDisplayName

public String destinationDisplayName()
            throws xdoclet.XDocletException
Returns the display-name of the current message destination
Returns:
Current message destination's display-name
Throws:
xdoclet.XDocletException -
See Also:
forAllDestinations(java.lang.String)
doc.tag
type = "content"

destinationJndiName

public String destinationJndiName()
            throws xdoclet.XDocletException
Returns the jndi-name of the current message destination
Returns:
Current message destination's jndi-name
Throws:
xdoclet.XDocletException -
See Also:
forAllDestinations(java.lang.String)
doc.tag
type = "content"

destinationName

public String destinationName()
            throws xdoclet.XDocletException
Returns the name of the current message destination
Returns:
Current message destination's name
Throws:
xdoclet.XDocletException -
See Also:
forAllDestinations(java.lang.String)
doc.tag
type = "content"

forAllDestinations

public void forAllDestinations(String template)
            throws xdoclet.XDocletException
Evaluates the body block for each ejb:message-destination defined in class level
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException -
See Also:
destinationName(), destinationDescription(), destinationDisplayName()
doc.tag
type = "block"

forAllMDBeans

public void forAllMDBeans(String template)
            throws xdoclet.XDocletException
Evaluates the body block for each EJBean derived from MessageDrivenBean.
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException -
See Also:
isMessageDriven(xjavadoc.XClass)
doc.tag
type = "block"

getMessageDrivenClassFor

public static String getMessageDrivenClassFor(XClass clazz)
Gets the MdbClassFor attribute of the MdbTagsHandler class
Parameters:
clazz - Describe what the parameter does
Returns:
The MessageDrivenClassFor value

getMessageDrivenClassPattern

protected static String getMessageDrivenClassPattern()
Gets the MdbClassPattern attribute of the MdbTagsHandler class
Returns:
The MdbClassPattern value

ifDestinationHasDescription

public void ifDestinationHasDescription(String template)
            throws xdoclet.XDocletException
Evaluate the body block if the current message destination has a descrition
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

ifDestinationHasDisplayName

public void ifDestinationHasDisplayName(String template)
            throws xdoclet.XDocletException
Evaluate the body block if the current message destination has a display-name
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

ifDestinationHasJndiName

public void ifDestinationHasJndiName(String template)
            throws xdoclet.XDocletException
Evaluate the body block if the current message destination has a jndi-name
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

ifHasActivationConfig

public void ifHasActivationConfig(String template,
                                  Properties attributes)
            throws xdoclet.XDocletException
Evaluate the body block if the current class has a activation config
Parameters:
template - The body of the block tag
attributes -
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

ifMessageDriven

public void ifMessageDriven(String template)
            throws xdoclet.XDocletException
Evaluate the body block if current class is of a message driven bean type.
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

ifNotMessageDriven

public void ifNotMessageDriven(String template)
            throws xdoclet.XDocletException
Evaluate the body block if current class is not of a message driven bean type.
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

isMessageDriven

public static boolean isMessageDriven(XClass clazz)
Returns true if clazz is a message-driven bean, false otherwise.
Parameters:
clazz - Description of Parameter
Returns:
The MessageDriven value

mdbClass

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

messageDrivenClass

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

Overview Package Class Use Tree Index Deprecated About
http://xdoclet.sourceforge.net/