xdoclet.modules.ejb
public class EjbTagsHandler extends XDocletTagSupport
Version: $Revision: 1.30 $
UNKNOWN: Oct 15, 2001 namespace = "Ejb"
Field Summary | |
---|---|
static String | ALL |
protected static String | LOCAL_SUFFIX |
static String | SERVICE_ENDPOINT |
static String | SERVICE_ENDPOINT_SUFFIX |
Method Summary | |
---|---|
String | beanType()
Returns Bean type : "Entity", "Session" or "Message Driven".
|
static String | choosePackage(String packageName, String packagePattern, String subtask)
Returns modified package name for a package name. |
String | concreteFullClassName()
Returns the full-qualified name of the current class's concrete class. |
String | ejbExternalRefName()
Returns the name of EJB ref.
|
String | ejbName(Properties attributes)
Returns the name of current EJB bean.
|
static String | ejbRefName()
Returns the name of EJB ref.
|
static String | ejbRefName(XTag tag, XClass clazz)
Returns the name of EJB ref.
|
protected String | extendsFromFor(XClass clazz, String tagName, String type, String extendsParamName, String defaultBaseClassName)
Returns the name of the class pk/etc class extends.
|
void | forAllBeans(String template)
Evaluates the body block for each EJBean derived from one of the three EJB types: EntityBean, SessionBean or
MessageDrivenBean.
|
protected String | getDependentClassFor(XClass clazz, String type)
sub-classes which deal with patternized class names return a reasonable value
|
protected String | getDependentClassTagName()
Gets the DependentClassTagName attribute of the EjbTagsHandler object
|
static XClass | getEjb(String name)
Returns the class with the specified ejb name
|
static String | getEjbIdFor(XClass clazz) |
static String | getEjbNameFor(XClass clazz)
Returns the EJB name of the clazz by seaching for ejb:bean's name parameter. |
static String | getEjbSpec()
Returns the EJB specification version used. |
static String | getShortEjbNameFor(XClass clazz)
Returns short version of the EJB name of the clazz.
|
protected boolean | hasTransaction(XDoc doc)
Returns true if class/method denoted by doc has ejb:transaction tag, false otherwise.
|
String | id()
Returns unique id for current ejb.
|
void | ifIsAConcreteEJBean(String template, 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(String template) |
void | ifNotLocalEjb(String template) |
void | ifNotRemoteEjb(String template) |
void | ifNotServiceEndpointEjb(String template) |
void | ifRemoteEjb(String template) |
void | ifServiceEndpointEjb(String template) |
static boolean | isAConcreteEJBean(XClass clazz)
Gets the AConcreteEJBean attribute of the EjbTagsHandler class
|
static boolean | isEjb(XClass clazz)
Returns true of clazz is an EJB (derived from an EJB type), false otherwise.
|
static boolean | isLocalEjb(XClass clazz) |
static boolean | isOnlyLocalEjb(XClass clazz)
Returns true if clazz is only a local EJB by looking at ejb:bean's view-type parameter.
|
static boolean | isOnlyRemoteEjb(XClass clazz)
Returns true if clazz is only a remote EJB by looking at ejb:bean's view-type parameter.
|
static boolean | isOnlyServiceEndpointEjb(XClass clazz)
Returns true if clazz is only a service endpoint EJB by looking at ejb:bean's view-type parameter.
|
static boolean | isRemoteEjb(XClass clazz) |
static boolean | isServiceEndpointEjb(XClass clazz) |
protected static String | prefixWithEjbSlash(String ejbName)
Replace "." by "/" and add "ejb/" to the parameter.
|
String | shortEjbName()
Returns short version of ejbName(). |
protected boolean | shouldTraverseSuperclassForDependentClass(XClass clazz, String tagName)
Describe what the method does
|
String | symbolicClassName()
Returns the symbolic name of the current class. |
Returns: "Entity", "Session" or "Message Driven".
Throws: XDocletException
See Also: EntityTagsHandler SessionTagsHandler MdbTagsHandler
UNKNOWN: type = "content"
Parameters: packageName The name of the package name the new package name will be derived from packagePattern The package pattern to use. Can be null subtask
Returns: Description of the Returned Value
UNKNOWN: this method is really an utility method that should be deprecated here and moved to PackageTagsHandler or even somewhere else
Returns: The full-qualified name of the current class's concrete class
Throws: XDocletException
See Also: sessionClass entityBmpClass entityCmpClass messageDrivenClass
UNKNOWN: type = "content"
Returns: The name of current EJB bean.
Throws: XDocletException
UNKNOWN: type = "content"
Parameters: attributes The attributes of the template tag
Returns: The name of current EJB bean.
Throws: XDocletException
See Also: EjbTagsHandler
UNKNOWN: type = "content" name = "prefixWithEjbSlash" optional = "true" values = "true,false" description = "Specifies * whether to prefix it with ejb/ or not. False by default."
Returns: The name of current EJB bean.
Throws: XDocletException
UNKNOWN: type = "content"
Parameters: tag clazz
Returns: The name of current EJB bean.
Throws: XDocletException
UNKNOWN: type = "content"
Parameters: clazz the class tagName name of the tag (ejb:bean for example, used for getting generate parameter) type type value used for view type of remote/local extendsParamName 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 class
Returns: correct value for the extends statement of a generated class
Throws: XDocletException
Parameters: template The body of the block tag
Throws: XDocletException
See Also: EntityTagsHandler SessionTagsHandler MdbTagsHandler
UNKNOWN: type = "block"
Parameters: clazz the class type type value used for view-type of remote/local
Returns: dependent class name for the class and type
Throws: XDocletException
Returns: The DependentClassTagName value
Parameters: name
Returns:
Throws: XDocletException
Parameters: clazz Description of Parameter
Returns: a unique id for clazz
Parameters: clazz The EJB bean class for which we want the EJB name
Returns: The EjbName value
See Also: EjbTagsHandler
Returns: The Ejbspec value
Parameters: clazz the class we want its short EJB name
Returns: The shortEjbName value
See Also: shortEjbName
Parameters: doc Description of Parameter
Returns: Description of the Returned Value
Throws: XDocletException
Returns: Description of the Returned Value
Throws: XDocletException
UNKNOWN: type = "content"
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: template Description of Parameter
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: template
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: template
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: template
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: template Description of Parameter
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: template Description of Parameter
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: clazz Describe what the parameter does
Returns: The AConcreteEJBean value
Throws: XDocletException
Parameters: clazz Description of Parameter
Returns: The Ejb value
Throws: XDocletException
Parameters: clazz Description of Parameter
Returns: The OnlyLocalEjb value
Throws: XDocletException
Parameters: clazz Description of Parameter
Returns: The OnlyRemoteEjb value
Throws: XDocletException
Parameters: clazz Description of Parameter
Returns: The OnlyRemoteEjb value
Throws: XDocletException
Parameters: ejbName The string to parse
Returns: The parsed String
Returns: Description of the Returned Value
Throws: XDocletException
See Also: EjbTagsHandler
UNKNOWN: type = "content"
Parameters: clazz Describe what the parameter does tagName Describe what the parameter does
Returns: Describe the return value
Throws: XDocletException
Returns: The symbolic name of the current class
Throws: XDocletException
See Also: shortEjbName
UNKNOWN: type = "content"