xdoclet.modules.ejb.env
public class EnvEjbRefTagsHandler extends EnvTagsHandler
currentMember, currentTag, currentTagType
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER
Constructor and Description |
---|
EnvEjbRefTagsHandler() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
componentInterface()
Returns the component interface for the current ejb reference
|
protected void |
doGenerate(java.lang.String template)
Called for each tag in the
forTags loop. |
java.lang.String |
ejbRefId()
Returns unique id for the specified ejb-ref.
|
java.lang.String |
ejbRefJndiName()
Returns the global JNDI name for the current EJB ref.
|
protected xjavadoc.XClass |
findEjb(java.lang.String ejbName)
Finds and returns the class with the specified ejbName.
|
void |
forAllEjbRefMembers(java.lang.String template,
java.util.Properties attributes)
Evaluates the body block for each method- and field-level ejb reference.
|
void |
forAllEjbRefMethods(java.lang.String template,
java.util.Properties attributes)
Evaluates the body block for each method-level ejb reference.
|
void |
forAllEjbRefs(java.lang.String template,
java.util.Properties attributes)
Evaluates the body block for each ejb reference.
|
java.lang.String |
homeInterface()
Returns the home interface for the current ejb reference
|
void |
ifLocalEjbRef(java.lang.String template)
Generates code if the ejb-ref is local
|
void |
ifRemoteEjbRef(java.lang.String template)
Generates code if the ejb-ref is local
|
protected boolean |
isLocalEjbRef(xjavadoc.XTag ejbRefTag)
Return true if the ejb-ref is local
|
protected boolean |
isRemoteEjbRef(xjavadoc.XTag ejbRefTag)
Return true if the ejb-ref is remote
|
java.lang.String |
name(java.util.Properties attributes)
Returns the name parameter value for the current tag.
|
protected void |
storeReferringClassId()
Stores the id of current EJB for further use by other tags in referringClassId attribute.
|
forAllMemberTags, forAllMethodTags, forAllTags, forTags, ifHasParam, ifHasTag, ifHasType, ifNotPrimitiveMember, ifParamValueEquals, ifParamValueNotEquals, ifPrimitiveMember, memberName, memberType, methodSignature, paramValue, type
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
getXJavaDoc, setXJavaDoc
public java.lang.String ejbRefId() throws XDocletException
XDocletException
public void forAllEjbRefs(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
public void forAllEjbRefMembers(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
public void forAllEjbRefMethods(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
public java.lang.String ejbRefJndiName() throws XDocletException
XDocletException
public void ifLocalEjbRef(java.lang.String template) throws XDocletException
template
- XDocletException
public void ifRemoteEjbRef(java.lang.String template) throws XDocletException
template
- XDocletException
public java.lang.String name(java.util.Properties attributes) throws XDocletException
EnvTagsHandler
name
in class EnvTagsHandler
attributes
- the attributesXDocletException
- if an error occurespublic java.lang.String homeInterface() throws XDocletException
XDocletException
- if an error occurespublic java.lang.String componentInterface() throws XDocletException
XDocletException
- if an error occuresprotected boolean isLocalEjbRef(xjavadoc.XTag ejbRefTag) throws XDocletException
ejbRefTag
- XDocletException
protected boolean isRemoteEjbRef(xjavadoc.XTag ejbRefTag) throws XDocletException
ejbRefTag
- XDocletException
protected void doGenerate(java.lang.String template) throws XDocletException
EnvTagsHandler
forTags
loop. The default behaviour is to call generate(template)
doGenerate
in class EnvTagsHandler
template
- the templateXDocletException
- if an error occuresprotected void storeReferringClassId() throws XDocletException
XDocletException
protected xjavadoc.XClass findEjb(java.lang.String ejbName) throws XDocletException
ejbName
- Description of ParameterXDocletException