xdoclet.modules.ejb.mdb

Class MdbTagsHandler

public class MdbTagsHandler extends EjbTagsHandler

Version: $Revision: 1.16 $

Author: Ara Abrahamian (ara_e@email.com)

UNKNOWN: Oct 16, 2001 namespace = "EjbMdb"

Method Summary
StringdestinationDescription()
Returns the description of the current message destination
StringdestinationDisplayName()
Returns the display-name of the current message destination
StringdestinationJndiName()
Returns the jndi-name of the current message destination
StringdestinationName()
Returns the name of the current message destination
voidforAllDestinations(String template)
Evaluates the body block for each ejb:message-destination defined in class level
voidforAllMDBeans(String template)
Evaluates the body block for each EJBean derived from MessageDrivenBean.
static StringgetMessageDrivenClassFor(XClass clazz)
Gets the MdbClassFor attribute of the MdbTagsHandler class
protected static StringgetMessageDrivenClassPattern()
Gets the MdbClassPattern attribute of the MdbTagsHandler class
voidifDestinationHasDescription(String template)
Evaluate the body block if the current message destination has a descrition
voidifDestinationHasDisplayName(String template)
Evaluate the body block if the current message destination has a display-name
voidifDestinationHasJndiName(String template)
Evaluate the body block if the current message destination has a jndi-name
voidifHasActivationConfig(String template, Properties attributes)
Evaluate the body block if the current class has a activation config
voidifMessageDriven(String template)
Evaluate the body block if current class is of a message driven bean type.
voidifNotMessageDriven(String template)
Evaluate the body block if current class is not of a message driven bean type.
static booleanisMessageDriven(XClass clazz)
Returns true if clazz is a message-driven bean, false otherwise.
StringmdbClass()
Returns the name of message-driven bean class.
StringmessageDrivenClass()
Returns the name of message-driven bean class.

Method Detail

destinationDescription

public String destinationDescription()
Returns the description of the current message destination

Returns: Current message destination's description

Throws: XDocletException

See Also: MdbTagsHandler

UNKNOWN: type = "content"

destinationDisplayName

public String destinationDisplayName()
Returns the display-name of the current message destination

Returns: Current message destination's display-name

Throws: XDocletException

See Also: MdbTagsHandler

UNKNOWN: type = "content"

destinationJndiName

public String destinationJndiName()
Returns the jndi-name of the current message destination

Returns: Current message destination's jndi-name

Throws: XDocletException

See Also: MdbTagsHandler

UNKNOWN: type = "content"

destinationName

public String destinationName()
Returns the name of the current message destination

Returns: Current message destination's name

Throws: XDocletException

See Also: MdbTagsHandler

UNKNOWN: type = "content"

forAllDestinations

public void forAllDestinations(String template)
Evaluates the body block for each ejb:message-destination defined in class level

Parameters: template The body of the block tag

Throws: XDocletException

See Also: destinationName destinationDescription destinationDisplayName

UNKNOWN: type = "block"

forAllMDBeans

public void forAllMDBeans(String template)
Evaluates the body block for each EJBean derived from MessageDrivenBean.

Parameters: template The body of the block tag

Throws: XDocletException

See Also: MdbTagsHandler

UNKNOWN: 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)
Evaluate the body block if the current message destination has a descrition

Parameters: template The body of the block tag

Throws: XDocletException

UNKNOWN: type = "block"

ifDestinationHasDisplayName

public void ifDestinationHasDisplayName(String template)
Evaluate the body block if the current message destination has a display-name

Parameters: template The body of the block tag

Throws: XDocletException

UNKNOWN: type = "block"

ifDestinationHasJndiName

public void ifDestinationHasJndiName(String template)
Evaluate the body block if the current message destination has a jndi-name

Parameters: template The body of the block tag

Throws: XDocletException

UNKNOWN: type = "block"

ifHasActivationConfig

public void ifHasActivationConfig(String template, Properties attributes)
Evaluate the body block if the current class has a activation config

Parameters: template The body of the block tag attributes

Throws: XDocletException

UNKNOWN: type = "block"

ifMessageDriven

public void ifMessageDriven(String template)
Evaluate the body block if current class is of a message driven bean type.

Parameters: template The body of the block tag

Throws: XDocletException

UNKNOWN: type = "block"

ifNotMessageDriven

public void ifNotMessageDriven(String template)
Evaluate the body block if current class is not of a message driven bean type.

Parameters: template The body of the block tag

Throws: XDocletException

UNKNOWN: 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()
Returns the name of message-driven bean class.

Returns: The name of generated message-driven bean class.

Throws: XDocletException

UNKNOWN: type = "content"

messageDrivenClass

public String messageDrivenClass()
Returns the name of message-driven bean class.

Returns: The name of generated message-driven bean class.

Throws: XDocletException

UNKNOWN: type = "content"