xdoclet.ejb.tags
Class UtilTagsHandler

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

public class UtilTagsHandler

extends EjbTagsHandler

Version:

$Revision: 1.12 $

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

UtilTagsHandler()

Method Summary

static java.lang.String	getUtilClassFor(com.sun.javadoc.ClassDoc clazz) Similar to InterfaceTagsHandler.getComponentInterface(java.lang.String, com.sun.javadoc.ClassDoc).
protected static java.lang.String	getUtilClassPattern()
java.lang.String	lookupKind()
java.lang.String	utilClass(java.util.Properties attributes) Returns the full qualified utility class name for the bean

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

UtilTagsHandler

public UtilTagsHandler()

Method Detail

getUtilClassFor

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

Similar to InterfaceTagsHandler.getComponentInterface(java.lang.String, com.sun.javadoc.ClassDoc). Relies on the ejb:home tag, which has the following relevant properties:

• remote-class: The fully qualified name of the remote class - overrides all set patterns
• local-class: The fully qualified name of the local class - overrides all set patterns
• remote-pattern: The pattern to be used to determine the unqualified name of the remote class
• local-pattern: The pattern to be used to determine the unqualified name of the local class
• pattern: The pattern to be used in determining the unqualified remote and/or local home interface name - used where remote- or local- pattern are not specified.
• remote-package: The package the remote home interface is to be placed in
• local-package: The package the local home interface is to be placed in
• package: The package the remote and/or local home interface is to be placed in - used where remote- or local- package are not specified.

Parameters:

clazz - Description of Parameter

Returns:

The HomeInterface value

Throws:

XDocletException - Description of Exception

getUtilClassPattern

protected static java.lang.String getUtilClassPattern()

lookupKind

public java.lang.String lookupKind()
                            throws XDocletException

utilClass

public java.lang.String utilClass(java.util.Properties attributes)
                           throws XDocletException

Returns the full qualified utility class name for the bean

Parameters:

attributes - The attributes of the template tag

Returns:

Utility class name

Throws:

XDocletException - Description of Exception