xdoclet.modules.ejb.intf
public class InterfaceTagsHandler extends EjbTagsHandler
Version: $Revision: 1.21 $
UNKNOWN: Oct 15, 2001 namespace = "EjbIntf"
Field Summary | |
---|---|
static String | SERVICE_ENDPOINT_EXTENDS_PARAM |
static String | SERVICE_ENDPOINT_INTERFACE |
Method Summary | |
---|---|
String | beanClassNameFromInterfaceName(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.
|
String | classTagIntf()
Returns the current interface inside a forAllClassTagIntf block
|
String | componentInterface(Properties attributes)
Returns the full qualified local or remote interface name for the bean, depending on the value of type parameter.
|
String | extendsFrom(Properties attributes)
Returns the name of the class home interface extends.
|
void | forAllClassTagIntf(String template, 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(String template, Properties attributes)
Evaluates the body block for each view-type of current method. |
protected String | fromInterfaceToBean(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 String | getBeanClassNameFromInterfaceNameFor(String return_type)
Gets the BeanClassNameFromInterfaceNameFor attribute of the InterfaceTagsHandler class
|
static String | getComponentInterface(String type, XClass clazz)
Return the fully qualified name of the component interface of type specified. |
protected String | getDependentClassFor(XClass clazz, String type)
Gets the DependentClassFor attribute of the InterfaceTagsHandler object
|
protected String | getInterfaceMethodName(String name)
Returns the interface method name depending on its type.
|
protected static String | getLocalClassPattern()
Gets the LocalClassPattern attribute of the InterfaceTagsHandler class
|
protected static String | getRemoteClassPattern()
Gets the RemoteClassPattern attribute of the InterfaceTagsHandler class
|
protected static String | getServiceEndpointClassPattern()
Gets the LocalClassPattern attribute of the InterfaceTagsHandler class
|
void | ifCurrentMethodViewTypeEquals(String template, 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(String template)
Evaluates the body if a current interface is available inside a forAllClassTagIntf block
|
void | ifIsInterfaceMethod(String template, Properties attributes)
Evaluate the body block if the current method is an EJB local or remote interface method.
|
void | ifIsInterfaceMethod(String template)
Evaluates the body block if ejb:interface-method defined for current method.
|
void | ifIsNotInterfaceMethod(String template, Properties attributes)
Evaluate the body block if the current method is not an EJB local or remote interface method.
|
String | interfaceMethodName()
Returns interface method name for the current interface method.
|
static boolean | isComponentInterfaceMethod(XMethod method)
Returns true if method is a component interface method, false otherwise. |
static boolean | isInterfaceMethod(XMethod method)
Returns true if method is an interface method, false otherwise. |
protected boolean | isInterfaceMethod(String intFace)
Implements functionality required by {@link #ifIsInterfaceMethod} and {@link #ifIsNotInterfaceMethod}. |
static boolean | isLocalMethod(XMethod method)
Returns true if method is a local interface method by looking at view-type parameter.
|
static boolean | isRemoteMethod(XMethod method)
Returns true if method is a remote interface method by looking at view-type parameter.
|
static boolean | isServiceEndpointMethod(XMethod method)
Returns true if method is a local interface method by looking at view-type parameter.
|
String | methodIntf(Properties attributes)
Returns "Remote" is current method has ejb:remote-method defined, "Home" otherwise.
|
Parameters: attributes
Returns: Bean class name
Throws: XDocletException
UNKNOWN: type = "content"
Returns:
Throws: XDocletException Description of Exception
See Also: InterfaceTagsHandler
UNKNOWN: type = "content"
Parameters: attributes The attributes of the template tag
Returns: Description of the Returned Value
Throws: XDocletException
UNKNOWN: type = "content" name = "type" optional = "false" values = "remote,local" description = "Specifies the type * of component interface."
Parameters: attributes
Returns: The name of generated PK class.
Throws: XDocletException
UNKNOWN: type = "content"
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block" name = "paramName" optional = "false" description = "The param name for the view-type on * the current class tag."
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: value Description of Parameter
Returns: Description of the Returned Value
Throws: XDocletException
Parameters: return_type Describe what the parameter does
Returns: The BeanClassNameFromInterfaceNameFor value
Throws: XDocletException
ejb:interface
class level tag. Relevant parameters for the ejb:interface
tag are:
Parameters: type Can be remote or local. Defaults to remote. clazz Description of Parameter
Returns: The fully qualified name of the interface.
Throws: XDocletException
Parameters: clazz Describe what the parameter does type Describe what the parameter does
Returns: The DependentClassFor value
Throws: XDocletException
Parameters: name Description of Parameter
Returns: "create" if ejbCreate, "remote" if ejbRemove, find
Throws: XDocletException
Returns: The LocalClassPattern value
Returns: The RemoteClassPattern value
Returns: The LocalClassPattern value
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block" name = "paramName" optional = "false" description = +The paramnamefor theview-typeon thecurrentmethod tag"
Parameters: template The body of the block tag
Throws: XDocletException Description of Exception
See Also: InterfaceTagsHandler
UNKNOWN: type = "block"
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException
UNKNOWN: type = "block" name = "interface" optional = "false" description = "The type of interface to check for * the methods validity in. Can be either \"local\" or \"remote\"." name = "superclasses" optional = "true" description = "Traverse superclasses too. With * false value used in remote/local. Default is True."
Parameters: template The body of the block tag
Throws: XDocletException
See Also: InterfaceTagsHandler
UNKNOWN: type = "block"
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException
UNKNOWN: type = "block" name = "interface" optional = "false" description = "The type of interface to check for * the methods validity in. Can be either \"local\" or \"remote\"."
Returns: "Remote" or "Home".
Throws: XDocletException
See Also: InterfaceTagsHandler
UNKNOWN: type = "content"
Parameters: method Description of Parameter
Returns: The RemoteMethod value
Parameters: method Description of Parameter
Returns: The InterfaceMethod value
view-type
parameter to
the method level ejb:interface-method
tag. If that is absent use the view-type
tag from
ejb:bean
.
Parameters: intFace The type of interface to test the method for.
Returns: true if the method should occur in the specified interface.
Throws: XDocletException
Parameters: method Description of Parameter
Returns: The isRemoteMethod value
Throws: XDocletException
Parameters: method Description of Parameter
Returns: The isRemoteMethod value
Throws: XDocletException
Parameters: method Description of Parameter
Returns: The isRemoteMethod value
Throws: XDocletException
Parameters: attributes The attributes of the template tag
Returns: "Remote" or "Home".
Throws: XDocletException
See Also: InterfaceTagsHandler
UNKNOWN: type = "content"