xdoclet.modules.web
Class WebTagsHandler

java.lang.Object
  extended by xdoclet.template.TemplateTagHandler
      extended by xdoclet.XDocletTagSupport
          extended by xdoclet.modules.web.WebTagsHandler

public class WebTagsHandler
extends XDocletTagSupport

Version:
$Revision: 1.4 $
Author:
Marcus Brito (pazu@animegaiden.com.br), Christoph G. Jung (christoph.jung@infor.de)
xdoclet.taghandler
namespace = "Web"
created
Jun 28, 2002

Field Summary
 
Fields inherited from class xdoclet.XDocletTagSupport
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER
 
Constructor Summary
WebTagsHandler()
           
 
Method Summary
static java.lang.String choosePackage(java.lang.String packageName, java.lang.String packagePattern, java.lang.String subtask)
           
 java.lang.String extendsFrom(java.util.Properties attributes)
          Returns the name of the class home interface extends.
 void forAllEjbLocalRefs(java.lang.String template)
          Process the tag body for each web:ejb-local-ref tag in all source files.
 void forAllEjbRefs(java.lang.String template)
          Process the tag body for each web:ejb-ref tag in all source files.
 void forAllEnvEntries(java.lang.String template)
          Process the tag body for each web:env-entry tag in all source files.
 void forAllResourceEnvRefs(java.lang.String template)
          Process the tag body for each web:resource-env-ref tag in all source files.
 void forAllResourceRefs(java.lang.String template)
          Process the tag body for each web:resource-ref tag in all source files.
 void forAllSecurityRoles(java.lang.String template)
          Process the tag body for each web:security-role tag in all source files.
static java.lang.String serviceEndpoint(java.util.Properties properties)
           
static java.lang.String serviceEndpoint(xjavadoc.XClass clazz)
           
static java.lang.String servletName(java.util.Properties properties)
           
static java.lang.String servletName(xjavadoc.XClass clazz)
           
static java.lang.String shortServletName(xjavadoc.XClass clazz)
          Returns short version of the servlet name of the clazz.
 
Methods inherited from class xdoclet.XDocletTagSupport
delimit, expandClassName, generate, getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getDocletContext, getEngine, getExpandedDelimitedTagValue, getTagValue, getTagValue, getTagValue, hasHavingClassTag, hasTag, isTagValueEqual, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, modifiers, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
 
Methods inherited from class xdoclet.template.TemplateTagHandler
getXJavaDoc, setXJavaDoc
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebTagsHandler

public WebTagsHandler()
Method Detail

shortServletName

public static java.lang.String shortServletName(xjavadoc.XClass clazz)
Returns short version of the servlet name of the clazz.

Parameters:
clazz - the class we want its short servlet name
Returns:
The shortName value
See Also:
#shortName()

serviceEndpoint

public static java.lang.String serviceEndpoint(xjavadoc.XClass clazz)
                                        throws XDocletException
Throws:
XDocletException

serviceEndpoint

public static java.lang.String serviceEndpoint(java.util.Properties properties)
                                        throws XDocletException
Throws:
XDocletException

servletName

public static java.lang.String servletName(java.util.Properties properties)

servletName

public static java.lang.String servletName(xjavadoc.XClass clazz)

choosePackage

public static java.lang.String choosePackage(java.lang.String packageName,
                                             java.lang.String packagePattern,
                                             java.lang.String subtask)

forAllEjbRefs

public void forAllEjbRefs(java.lang.String template)
                   throws XDocletException
Process the tag body for each web:ejb-ref tag in all source files. Please note that this tag already iterates over all available sources; it should not be enclosed by a <XDtClass:forAllClasses> tag or any other that process classes. This tag does not process tags with duplicated name attributes. If such tags occurs, only the first tag is processed, and further tags will only emit a warning message.

Parameters:
template - The body of the block tag
Throws:
XDocletException - if something goes wrong
doc.tag
type = "block"

forAllEjbLocalRefs

public void forAllEjbLocalRefs(java.lang.String template)
                        throws XDocletException
Process the tag body for each web:ejb-local-ref tag in all source files. Look at forAllEjbRefs for some notes about the behavior of this tag.

Parameters:
template - The body of the blocktag
Throws:
XDocletException - if something goes wrong
doc.tag
type = "block"

forAllResourceRefs

public void forAllResourceRefs(java.lang.String template)
                        throws XDocletException
Process the tag body for each web:resource-ref tag in all source files. Look at forAllEjbRefs for some notes about the behavior of this tag.

Parameters:
template - The body of the blocktag
Throws:
XDocletException - if something goes wrong
doc.tag
type = "block"

forAllResourceEnvRefs

public void forAllResourceEnvRefs(java.lang.String template)
                           throws XDocletException
Process the tag body for each web:resource-env-ref tag in all source files. Look at forAllEjbRefs for some notes about the behavior of this tag.

Parameters:
template - The body of the blocktag
Throws:
XDocletException - if something goes wrong
doc.tag
type = "block"

forAllSecurityRoles

public void forAllSecurityRoles(java.lang.String template)
                         throws XDocletException
Process the tag body for each web:security-role tag in all source files. Look at forAllEjbRefs for some notes about the behavior of this tag.

Parameters:
template - The body of the blocktag
Throws:
XDocletException - if something goes wrong
doc.tag
type = "block"

forAllEnvEntries

public void forAllEnvEntries(java.lang.String template)
                      throws XDocletException
Process the tag body for each web:env-entry tag in all source files. Look at forAllEjbRefs for some notes about the behavior of this tag.

Parameters:
template - The body of the blocktag
Throws:
XDocletException - if something goes wrong
doc.tag
type = "block"

extendsFrom

public java.lang.String extendsFrom(java.util.Properties attributes)
                             throws XDocletException
Returns the name of the class home interface extends.

Parameters:
attributes -
Returns:
The name of generated PK class.
Throws:
XDocletException
doc.tag
type = "content"

http://xdoclet.sourceforge.net/