xdoclet.ejb.tags
Class SessionTagsHandler

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

public class SessionTagsHandler

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

SessionTagsHandler()

Method Summary

void	forAllSessionBeans(java.lang.String template) Evaluates the body block for each EJBean derived from SessionBean.
void	forAllStatefulSessionBeans(java.lang.String template) Evaluates the body block for each EJBean derived from SessionBean which is stateful.
void	forAllStatelessSessionBeans(java.lang.String template) Evaluates the body block for each EJBean derived from SessionBean which is stateless.
static java.lang.String	getSessionClassFor(com.sun.javadoc.ClassDoc clazz)
protected static java.lang.String	getSessionClassPattern()
void	ifNotStatelessSession(java.lang.String template) Evaluate the body block if current class is not of an stateless session bean type.
void	ifStatefulSession(java.lang.String template) Evaluate the body block if current class is of an stateful session bean type.
void	ifStatelessSession(java.lang.String template) Evaluate the body block if current class is of an stateless session bean type.
static boolean	isSession(com.sun.javadoc.ClassDoc clazz) Returns true if clazz is a session bean, false otherwise.
boolean	isStatefulSession(com.sun.javadoc.ClassDoc clazz) Returns true if clazz is a stateful session bean, false otherwise.
boolean	isStatelessSession(com.sun.javadoc.ClassDoc clazz) Returns true if clazz is a stateless session bean, false otherwise.
java.lang.String	sessionClass() Returns the name of generated session class.

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

SessionTagsHandler

public SessionTagsHandler()

Method Detail

getSessionClassFor

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

isSession

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

Returns true if clazz is a session bean, false otherwise.

Parameters:

clazz - Description of Parameter

Returns:

The Session value

Throws:

XDocletException - Description of Exception

getSessionClassPattern

protected static java.lang.String getSessionClassPattern()

isStatefulSession

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

Returns true if clazz is a stateful session bean, false otherwise. Entity type is determined by looking at the ejb:bean's type parameter.

Parameters:

clazz - Description of Parameter

Returns:

The StatefulSession value

Throws:

XDocletException - Description of Exception

isStatelessSession

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

Returns true if clazz is a stateless session bean, false otherwise. Entity type is determined by looking at the ejb:bean's type parameter.

Parameters:

clazz - Description of Parameter

Returns:

The StatelessSession value

Throws:

XDocletException - Description of Exception

sessionClass

public java.lang.String sessionClass()
                              throws XDocletException

Returns the name of generated session class.

Returns:

The name of generated session class.

Throws:

XDocletException - Description of Exception

ifStatelessSession

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

Evaluate the body block if current class is of an stateless session bean type.

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

See Also:

isStatelessSession(com.sun.javadoc.ClassDoc)

ifNotStatelessSession

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

Evaluate the body block if current class is not of an stateless session bean type.

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

See Also:

isStatelessSession(com.sun.javadoc.ClassDoc)

ifStatefulSession

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

Evaluate the body block if current class is of an stateful session bean type.

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

See Also:

isStatefulSession(com.sun.javadoc.ClassDoc)

forAllSessionBeans

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

Evaluates the body block for each EJBean derived from SessionBean.

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

See Also:

isSession(com.sun.javadoc.ClassDoc)

forAllStatefulSessionBeans

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

Evaluates the body block for each EJBean derived from SessionBean which is stateful.

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

See Also:

isStatefulSession(com.sun.javadoc.ClassDoc)

forAllStatelessSessionBeans

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

Evaluates the body block for each EJBean derived from SessionBean which is stateless.

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

See Also:

isStatelessSession(com.sun.javadoc.ClassDoc)