xdoclet.modules.ejb.intf
public class InterfaceTagsHandler extends EjbTagsHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
SERVICE_ENDPOINT_EXTENDS_PARAM |
static java.lang.String |
SERVICE_ENDPOINT_INTERFACE |
ALL, LOCAL_SUFFIX, SERVICE_ENDPOINT, SERVICE_ENDPOINT_SUFFIX
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER
Constructor and Description |
---|
InterfaceTagsHandler() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
beanClassNameFromInterfaceName(java.util.Properties attributes)
Returns the bean implementation class name for the interface name specified as the return type of current method
or the method specified by parameter interface if any.
|
java.lang.String |
classTagIntf()
Returns the current interface inside a forAllClassTagIntf block
|
java.lang.String |
componentInterface(java.util.Properties attributes)
Returns the full qualified local or remote interface name for the bean, depending on the value of type parameter.
|
java.lang.String |
extendsFrom(java.util.Properties attributes)
Returns the name of the class home interface extends.
|
void |
forAllClassTagIntf(java.lang.String template,
java.util.Properties attributes)
Evaluates the body for all interfaces which are compatible to the view-type which is set on the current class
tag.
|
void |
forAllInterfaceViewTypes(java.lang.String template,
java.util.Properties attributes)
Evaluates the body block for each view-type of current method.
|
protected java.lang.String |
fromInterfaceToBean(java.lang.String value)
Loops over all classes and if value equals to local or remote or service-endpoint interface name of an EJBean
full qualified name of that EJB is returned.
|
static java.lang.String |
getBeanClassNameFromInterfaceNameFor(java.lang.String return_type)
Gets the BeanClassNameFromInterfaceNameFor attribute of the InterfaceTagsHandler class
|
static java.lang.String |
getComponentInterface(java.lang.String type,
xjavadoc.XClass clazz)
Return the fully qualified name of the component interface of type specified.
|
protected java.lang.String |
getDependentClassFor(xjavadoc.XClass clazz,
java.lang.String type)
Gets the DependentClassFor attribute of the InterfaceTagsHandler object
|
protected java.lang.String |
getInterfaceMethodName(java.lang.String name)
Returns the interface method name depending on its type.
|
protected static java.lang.String |
getLocalClassPattern()
Gets the LocalClassPattern attribute of the InterfaceTagsHandler class
|
protected static java.lang.String |
getRemoteClassPattern()
Gets the RemoteClassPattern attribute of the InterfaceTagsHandler class
|
protected static java.lang.String |
getServiceEndpointClassPattern()
Gets the LocalClassPattern attribute of the InterfaceTagsHandler class
|
void |
ifCurrentMethodViewTypeEquals(java.lang.String template,
java.util.Properties attributes)
Evaluates the body if the view-type of the current method is compatible with the value of the current method
tag's parameter with the passed name.
|
void |
ifHasClassTagIntf(java.lang.String template)
Evaluates the body if a current interface is available inside a forAllClassTagIntf block
|
void |
ifIsInterfaceMethod(java.lang.String template)
Evaluates the body block if ejb:interface-method defined for current method.
|
void |
ifIsInterfaceMethod(java.lang.String template,
java.util.Properties attributes)
Evaluate the body block if the current method is an EJB local or remote interface method.
|
void |
ifIsNotInterfaceMethod(java.lang.String template,
java.util.Properties attributes)
Evaluate the body block if the current method is not an EJB local or remote interface method.
|
java.lang.String |
interfaceMethodName()
Returns interface method name for the current interface method.
|
static boolean |
isComponentInterfaceMethod(xjavadoc.XMethod method)
Returns true if method is a component interface method, false otherwise.
|
protected boolean |
isInterfaceMethod(java.lang.String intFace)
Implements functionality required by
ifIsInterfaceMethod(java.lang.String, java.util.Properties) and ifIsNotInterfaceMethod(java.lang.String, java.util.Properties) . |
static boolean |
isInterfaceMethod(xjavadoc.XMethod method)
Returns true if method is an interface method, false otherwise.
|
static boolean |
isLocalMethod(xjavadoc.XMethod method)
Returns true if method is a local interface method by looking at view-type parameter.
|
static boolean |
isRemoteMethod(xjavadoc.XMethod method)
Returns true if method is a remote interface method by looking at view-type parameter.
|
static boolean |
isServiceEndpointMethod(xjavadoc.XMethod method)
Returns true if method is a local interface method by looking at view-type parameter.
|
java.lang.String |
methodIntf(java.util.Properties attributes)
Returns "Remote" is current method has ejb:remote-method defined, "Home" otherwise.
|
beanType, choosePackage, concreteFullClassName, ejbExternalRefName, ejbName, ejbRefName, ejbRefName, extendsFromFor, forAllBeans, getDependentClassTagName, getEjb, getEjbIdFor, getEjbNameFor, getEjbSpec, getShortEjbNameFor, hasTransaction, id, ifIsAConcreteEJBean, ifLocalEjb, ifNotLocalEjb, ifNotRemoteEjb, ifNotServiceEndpointEjb, ifRemoteEjb, ifServiceEndpointEjb, isAConcreteEJBean, isEjb, isLocalEjb, isOnlyLocalEjb, isOnlyRemoteEjb, isOnlyServiceEndpointEjb, isRemoteEjb, isServiceEndpointEjb, prefixWithEjbSlash, shortEjbName, shouldTraverseSuperclassForDependentClass, symbolicClassName
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_INTERFACE
public static final java.lang.String SERVICE_ENDPOINT_EXTENDS_PARAM
public static java.lang.String getComponentInterface(java.lang.String type, xjavadoc.XClass clazz) throws XDocletException
ejb:interface
class level tag. Relevant parameters for the ejb:interface
tag are:
type
- Can be remote or local. Defaults to remote.clazz
- Description of ParameterXDocletException
public static boolean isInterfaceMethod(xjavadoc.XMethod method)
method
- Description of Parameterpublic static boolean isComponentInterfaceMethod(xjavadoc.XMethod method)
method
- Description of Parameterpublic static java.lang.String getBeanClassNameFromInterfaceNameFor(java.lang.String return_type) throws XDocletException
return_type
- Describe what the parameter doesXDocletException
public static boolean isRemoteMethod(xjavadoc.XMethod method) throws XDocletException
method
- Description of ParameterXDocletException
public static boolean isLocalMethod(xjavadoc.XMethod method) throws XDocletException
method
- Description of ParameterXDocletException
public static boolean isServiceEndpointMethod(xjavadoc.XMethod method) throws XDocletException
method
- Description of ParameterXDocletException
protected static java.lang.String getRemoteClassPattern()
protected static java.lang.String getLocalClassPattern()
protected static java.lang.String getServiceEndpointClassPattern()
public java.lang.String componentInterface(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
public void ifIsNotInterfaceMethod(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 ifIsInterfaceMethod(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 forAllInterfaceViewTypes(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 ifIsInterfaceMethod(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
isInterfaceMethod(xjavadoc.XMethod)
public java.lang.String methodIntf(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
isRemoteMethod(xjavadoc.XMethod)
public java.lang.String interfaceMethodName() throws XDocletException
XDocletException
getInterfaceMethodName(java.lang.String)
public java.lang.String beanClassNameFromInterfaceName(java.util.Properties attributes) throws XDocletException
attributes
- XDocletException
public java.lang.String extendsFrom(java.util.Properties attributes) throws XDocletException
attributes
- XDocletException
public void ifCurrentMethodViewTypeEquals(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic void forAllClassTagIntf(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic java.lang.String classTagIntf() throws XDocletException
XDocletException
- Description of ExceptionforAllClassTagIntf(String, Properties)
public void ifHasClassTagIntf(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
- Description of ExceptionforAllClassTagIntf(String, Properties)
protected boolean isInterfaceMethod(java.lang.String intFace) throws XDocletException
ifIsInterfaceMethod(java.lang.String, java.util.Properties)
and ifIsNotInterfaceMethod(java.lang.String, java.util.Properties)
. To
determine what interfaces the method should appear in, check the first for a view-type
parameter to
the method level ejb:interface-method
tag. If that is absent use the view-type
tag from
ejb:bean
.intFace
- The type of interface to test the method for.XDocletException
protected java.lang.String getInterfaceMethodName(java.lang.String name) throws XDocletException
name
- Description of ParameterXDocletException
protected java.lang.String getDependentClassFor(xjavadoc.XClass clazz, java.lang.String type) throws XDocletException
getDependentClassFor
in class EjbTagsHandler
clazz
- Describe what the parameter doestype
- Describe what the parameter doesXDocletException
protected java.lang.String fromInterfaceToBean(java.lang.String value) throws XDocletException
value
- Description of ParameterXDocletException