xdoclet.modules.ejb
public class EjbTagsHandler extends XDocletTagSupport
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ALL |
protected static java.lang.String |
LOCAL_SUFFIX |
static java.lang.String |
SERVICE_ENDPOINT |
static java.lang.String |
SERVICE_ENDPOINT_SUFFIX |
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER
Constructor and Description |
---|
EjbTagsHandler() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
beanType()
Returns Bean type : "Entity", "Session" or "Message Driven".
|
static java.lang.String |
choosePackage(java.lang.String packageName,
java.lang.String packagePattern,
java.lang.String subtask)
Returns modified package name for a package name.
|
java.lang.String |
concreteFullClassName()
Returns the full-qualified name of the current class's concrete class.
|
java.lang.String |
ejbExternalRefName()
Returns the name of EJB ref.
|
java.lang.String |
ejbName(java.util.Properties attributes)
Returns the name of current EJB bean.
|
static java.lang.String |
ejbRefName()
Returns the name of EJB ref.
|
static java.lang.String |
ejbRefName(xjavadoc.XTag tag,
xjavadoc.XClass clazz)
Returns the name of EJB ref.
|
protected java.lang.String |
extendsFromFor(xjavadoc.XClass clazz,
java.lang.String tagName,
java.lang.String type,
java.lang.String extendsParamName,
java.lang.String defaultBaseClassName)
Returns the name of the class pk/etc class extends.
|
void |
forAllBeans(java.lang.String template)
Evaluates the body block for each EJBean derived from one of the three EJB types: EntityBean, SessionBean or
MessageDrivenBean.
|
protected java.lang.String |
getDependentClassFor(xjavadoc.XClass clazz,
java.lang.String type)
sub-classes which deal with patternized class names return a reasonable value
|
protected java.lang.String |
getDependentClassTagName()
Gets the DependentClassTagName attribute of the EjbTagsHandler object
|
static xjavadoc.XClass |
getEjb(java.lang.String name)
Returns the class with the specified ejb name
|
static java.lang.String |
getEjbIdFor(xjavadoc.XClass clazz) |
static java.lang.String |
getEjbNameFor(xjavadoc.XClass clazz)
Returns the EJB name of the clazz by seaching for ejb:bean's name parameter.
|
static java.lang.String |
getEjbSpec()
Returns the EJB specification version used.
|
static java.lang.String |
getShortEjbNameFor(xjavadoc.XClass clazz)
Returns short version of the EJB name of the clazz.
|
protected boolean |
hasTransaction(xjavadoc.XDoc doc)
Returns true if class/method denoted by doc has ejb:transaction tag, false otherwise.
|
java.lang.String |
id()
Returns unique id for current ejb.
|
void |
ifIsAConcreteEJBean(java.lang.String template,
java.util.Properties attributes)
Evaluates the body block if current bean is a concrete bean meaning the generate parameter of ejb:bean is either
not specified or equals to "true", otherwise the bean is just an abstract base class bean not meant to be used as
a EJBean but serve as the base for other EJBeans.
|
void |
ifLocalEjb(java.lang.String template) |
void |
ifNotLocalEjb(java.lang.String template) |
void |
ifNotRemoteEjb(java.lang.String template) |
void |
ifNotServiceEndpointEjb(java.lang.String template) |
void |
ifRemoteEjb(java.lang.String template) |
void |
ifServiceEndpointEjb(java.lang.String template) |
static boolean |
isAConcreteEJBean(xjavadoc.XClass clazz)
Gets the AConcreteEJBean attribute of the EjbTagsHandler class
|
static boolean |
isEjb(xjavadoc.XClass clazz)
Returns true of clazz is an EJB (derived from an EJB type), false otherwise.
|
static boolean |
isLocalEjb(xjavadoc.XClass clazz) |
static boolean |
isOnlyLocalEjb(xjavadoc.XClass clazz)
Returns true if clazz is only a local EJB by looking at ejb:bean's view-type parameter.
|
static boolean |
isOnlyRemoteEjb(xjavadoc.XClass clazz)
Returns true if clazz is only a remote EJB by looking at ejb:bean's view-type parameter.
|
static boolean |
isOnlyServiceEndpointEjb(xjavadoc.XClass clazz)
Returns true if clazz is only a service endpoint EJB by looking at ejb:bean's view-type parameter.
|
static boolean |
isRemoteEjb(xjavadoc.XClass clazz) |
static boolean |
isServiceEndpointEjb(xjavadoc.XClass clazz) |
protected static java.lang.String |
prefixWithEjbSlash(java.lang.String ejbName)
Replace "." by "/" and add "ejb/" to the parameter.
|
java.lang.String |
shortEjbName()
Returns short version of ejbName().
|
protected boolean |
shouldTraverseSuperclassForDependentClass(xjavadoc.XClass clazz,
java.lang.String tagName)
Describe what the method does
|
java.lang.String |
symbolicClassName()
Returns the symbolic name of the current class.
|
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 static final java.lang.String SERVICE_ENDPOINT
public static final java.lang.String ALL
public static final java.lang.String SERVICE_ENDPOINT_SUFFIX
protected static final java.lang.String LOCAL_SUFFIX
public static boolean isAConcreteEJBean(xjavadoc.XClass clazz) throws XDocletException
clazz
- Describe what the parameter doesXDocletException
public static java.lang.String getEjbNameFor(xjavadoc.XClass clazz)
clazz
- The EJB bean class for which we want the EJB nameejbName(java.util.Properties)
public static java.lang.String getShortEjbNameFor(xjavadoc.XClass clazz)
clazz
- the class we want its short EJB nameshortEjbName()
public static java.lang.String getEjbIdFor(xjavadoc.XClass clazz)
clazz
- Description of Parameterpublic static java.lang.String getEjbSpec()
public static boolean isLocalEjb(xjavadoc.XClass clazz) throws XDocletException
XDocletException
public static boolean isRemoteEjb(xjavadoc.XClass clazz) throws XDocletException
XDocletException
public static boolean isServiceEndpointEjb(xjavadoc.XClass clazz) throws XDocletException
XDocletException
public static boolean isOnlyLocalEjb(xjavadoc.XClass clazz) throws XDocletException
clazz
- Description of ParameterXDocletException
public static boolean isOnlyRemoteEjb(xjavadoc.XClass clazz) throws XDocletException
clazz
- Description of ParameterXDocletException
public static boolean isOnlyServiceEndpointEjb(xjavadoc.XClass clazz) throws XDocletException
clazz
- Description of ParameterXDocletException
public static xjavadoc.XClass getEjb(java.lang.String name) throws XDocletException
name
- XDocletException
public static boolean isEjb(xjavadoc.XClass clazz) throws XDocletException
clazz
- Description of ParameterXDocletException
public static java.lang.String choosePackage(java.lang.String packageName, java.lang.String packagePattern, java.lang.String subtask)
packageName
- The name of the package name the new package name will be derived frompackagePattern
- The package pattern to use. Can be nullsubtask
- public static java.lang.String ejbRefName() throws XDocletException
XDocletException
public static java.lang.String ejbRefName(xjavadoc.XTag tag, xjavadoc.XClass clazz) throws XDocletException
tag
- clazz
- XDocletException
protected static java.lang.String prefixWithEjbSlash(java.lang.String ejbName)
ejbName
- The string to parsepublic java.lang.String ejbName(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
getEjbNameFor(xjavadoc.XClass)
public java.lang.String ejbExternalRefName() throws XDocletException
XDocletException
public java.lang.String symbolicClassName() throws XDocletException
XDocletException
shortEjbName()
public java.lang.String shortEjbName() throws XDocletException
XDocletException
getShortEjbNameFor(xjavadoc.XClass)
public void forAllBeans(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
EntityTagsHandler.isEntity(xjavadoc.XClass)
,
SessionTagsHandler.isSession(xjavadoc.XClass)
,
MdbTagsHandler.isMessageDriven(xjavadoc.XClass)
public void ifIsAConcreteEJBean(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 beanType() throws XDocletException
XDocletException
EntityTagsHandler.isEntity(xjavadoc.XClass)
,
SessionTagsHandler.isSession(xjavadoc.XClass)
,
MdbTagsHandler.isMessageDriven(xjavadoc.XClass)
public java.lang.String concreteFullClassName() throws XDocletException
XDocletException
SessionTagsHandler.sessionClass()
,
BmpTagsHandler.entityBmpClass()
,
CmpTagsHandler.entityCmpClass()
,
MdbTagsHandler.messageDrivenClass()
public java.lang.String id() throws XDocletException
XDocletException
public void ifLocalEjb(java.lang.String template) throws XDocletException
template
- Description of ParameterXDocletException
public void ifRemoteEjb(java.lang.String template) throws XDocletException
template
- Description of ParameterXDocletException
public void ifServiceEndpointEjb(java.lang.String template) throws XDocletException
template
- Description of ParameterXDocletException
public void ifNotLocalEjb(java.lang.String template) throws XDocletException
template
- XDocletException
public void ifNotRemoteEjb(java.lang.String template) throws XDocletException
template
- XDocletException
public void ifNotServiceEndpointEjb(java.lang.String template) throws XDocletException
template
- XDocletException
protected java.lang.String getDependentClassFor(xjavadoc.XClass clazz, java.lang.String type) throws XDocletException
clazz
- the classtype
- type value used for view-type of remote/localXDocletException
protected java.lang.String getDependentClassTagName()
protected boolean hasTransaction(xjavadoc.XDoc doc) throws XDocletException
doc
- Description of ParameterXDocletException
protected java.lang.String extendsFromFor(xjavadoc.XClass clazz, java.lang.String tagName, java.lang.String type, java.lang.String extendsParamName, java.lang.String defaultBaseClassName) throws XDocletException
clazz
- the classtagName
- name of the tag (ejb:bean for example, used for getting generate parameter)type
- type value used for view type of remote/localextendsParamName
- extends parameter name (is "extends" for ejb:bean but is "local-extends" for local)defaultBaseClassName
- default base class name, returned when not deriving from another base classXDocletException
protected boolean shouldTraverseSuperclassForDependentClass(xjavadoc.XClass clazz, java.lang.String tagName) throws XDocletException
clazz
- Describe what the parameter doestagName
- Describe what the parameter doesXDocletException