xdoclet.modules.ejb.home
public class HomeTagsHandler extends EjbTagsHandler
Version: $Revision: 1.37 $
UNKNOWN: Oct 15, 2001 namespace = "EjbHome"
Method Summary | |
---|---|
String | compName(Properties attributes) |
String | currentExceptions()
Return exceptions for current home method.
|
String | currentMethod()
Return name of current home method.
|
String | currentPermission()
Return permission for current home method.
|
String | currentSignature()
Return signature of current home method.
|
String | currentType()
Return type of current home method.
|
String | ejbPostCreateSignature(Properties attributes)
Returns the appropriate ejbPostCreate method name for the current ejbCreate method.
|
String | extendsFrom(Properties attributes)
Returns the name of the class home interface extends.
|
String | finderClass()
generates name for finder utility class backing current finder
|
static String | finderSignatureFunger(String s, XClass clazz, String type)
Describe what the method does
|
static XMethod | findFirstCreateMethodFor(XClass clazz)
Describe what the method does
|
void | forAllHomeMethods(String template, Properties attributes)
Iterates over all home methods of specified type (finder or create method) defined in a class and super classes.
|
static String | fullPackageChange(String s)
Convert various collection types within a string to their fully qualified forms.
|
static String | getCompNameFor(XClass clazz, String type)
Returns a suitable component name (which could be used, for example, in JNDI lookups) for a class.
|
protected String | getDependentClassFor(XClass clazz, String type)
Gets the DependentClassFor attribute of the HomeTagsHandler object
|
protected static String | getHomeClassPattern()
Gets the HomeClassPattern attribute of the HomeTagsHandler class.
|
static String | getHomeDefinition(XClass clazz, XMethod method, String tagType, String type)
Gets the HomeDefinition attribute of the HomeTagsHandler class
|
static String | getHomeInterface(String type, XClass clazz)
Similar to InterfaceTagsHandler. |
static String | getJndiNameOfTypeFor(String type, XClass clazz) |
protected static String | getLocalHomeClassPattern()
Gets the LocalHomeClassPattern attribute of the HomeTagsHandler class.
|
String | homeInterface(Properties attributes)
Returns the full qualified local or remote home interface name for the bean, depending on the value of type
parameter.
|
void | ifDoesntHavePostCreateMethod(String template, Properties attributes)
Evaluates the body block if current create method's ejbPostCreate method does not exist.
|
void | ifIsCollectionType(String template, Properties param)
Whether current finder return collection.
|
void | ifIsCreateMethod(String template, Properties attributes)
Evaluates the body block if current method is a create method. |
void | ifIsEnumerationType(String template, Properties param)
Whether current finder return enumeration.
|
void | ifIsFinderMethod(String template, Properties attributes)
Evaluates the body block if current method is a ejbFind method.
|
void | ifIsHomeMethod(String template, Properties attributes)
Evaluates the body block if current method is a home method. |
void | ifIsInterfaceType(String template, Properties param)
Whether current finder return interface.
|
void | ifNotRemoveMethod(String template)
Evaluates the body block if current method is not an ejbRemove method.
|
static boolean | isCreateMethod(XMethod method)
Returns true if method is a create method marked with a \@ejb.create-method tag, false otherwise.
|
static boolean | isFinderMethod(XMethod method)
Returns true if method is an ejbFind method, false otherwise.
|
static boolean | isHomeMethod(XMethod method)
Returns true if method is a home method marked with a \@ejb.home-method tag, false otherwise.
|
static boolean | isRemoveMethod(XMethod method)
Returns true if method is an ejbRemove method, false otherwise.
|
String | jndiName(Properties attributes) |
protected boolean | matchesViewType(XTag tag, String type)
Returns true if an XTag has a view-type compatible with the specified type. |
protected boolean | matchesViewType(Collection tags, String type)
Check every XTag in a collection and return true if they all have a view-type compatible with the specified type.
|
String | parameterList()
Return parameter list (names only) for current home method.
|
String | parameterListDefinition()
Return parameter list definition (types and names) for current home method.
|
protected void | setCurrentExceptions(String es)
Sets the CurrentExceptions attribute of the HomeTagsHandler object.
|
void | setCurrentPermission(String permission) |
protected void | setCurrentSignature(String cs)
Sets the CurrentSignature attribute of the HomeTagsHandler object.
|
protected boolean | shouldTraverseSuperclassForDependentClass(XClass clazz, String tag_name)
Describe what the method does
|
static String | toCreateMethod(String methodName)
Converts ejbCreateblabla to createblabla , the one that should appear in home interface.
|
static String | toFinderMethod(String methodName)
Converts ejbFindblabla to findblabla , the one that should appear in home interface.
|
static String | toHomeMethod(String methodName)
Converts ejbHomeblabla to homeblabla , the one that should appear in home interface.
|
Parameters: attributes The attributes of the template tag
Returns: Description of the Returned Value
Throws: XDocletException
UNKNOWN: type = "content" name = "prefixWithEjbSlash" optional = "true" values = "true,false" description = "Specifies * whether to prefix it with ejb/ or not. False by default." name = "type" optional = "false" values = "remote,local" description = "Specifies if we want * the jndi name value for local or remote lookup."
Returns: exceptions
Throws: XDocletException
UNKNOWN: type = "content"
Returns: method name
Throws: XDocletException
UNKNOWN: type = "content" i18n
Returns:
Throws: XDocletException
UNKNOWN: type = "content"
Returns: Describe the return value
Throws: XDocletException
Returns:
Throws: XDocletException
UNKNOWN: type = "content" i18n
Parameters: attributes The attributes of the template tag
Returns: Equivalent ejbPostCreate method name
UNKNOWN: type = "content"
Parameters: attributes
Returns: The name of generated PK class.
Throws: XDocletException
UNKNOWN: type = "content"
Returns:
Throws: XDocletException
UNKNOWN: type = "content" i18n
Parameters: s Describe what the parameter does clazz type
Returns: Describe the return value
Throws: XDocletException
Parameters: clazz Describe what the parameter does
Returns: Describe the return value
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException
UNKNOWN: type = "block" name = "tagName" optional = "false" description = "The tag name for the method type to * iterate over." values = "ejb:finder,ejb:create-method" name = "superclasses" values = "true,false" description = "If true then traverse * superclasses also, otherwise look up the tag in current concrete class only." name = "tagKey" description = "A tag property that will be used as a unique key. This is * used to avoid duplicate code due to similar tags in superclasses."
Parameters: s String to be converted.
Returns: String with fully qualified collection types.
Parameters: clazz the class type interface view type, \"local\" or \"remote\"
Returns: compname
Parameters: clazz Describe what the parameter does type Describe what the parameter does
Returns: The DependentClassFor value
Throws: XDocletException
Returns: The HomeClassPattern value
Parameters: clazz Describe what the parameter does method Describe what the parameter does tagType Describe what the parameter does type Describe what the parameter does
Returns: The HomeDefinition value
Throws: XDocletException
Parameters: type The type of home interface - can be remote or local. clazz Description of Parameter
Returns: The HomeInterface value
Throws: XDocletException
Returns: The LocalHomeClassPattern value
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 home interface."
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: template param
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException
See Also: HomeTagsHandler
UNKNOWN: type = "block" name = "superclasses" optional = "true" description = "Traverse superclasses too. With * false value used in remote/local home interface templates. Default is False."
Parameters: template param
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException Description of Exception
See Also: HomeTagsHandler
UNKNOWN: type = "block" name = "superclasses" optional = "true" description = "Traverse superclasses too. With * false value used in remote/local home interface templates. Default is False."
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException
See Also: HomeTagsHandler
UNKNOWN: type = "block" name = "superclasses" optional = "true" description = "Traverse superclasses too. With * false value used in remote/local home interface templates. Default is False."
Parameters: template param
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: template The body of the block tag
Throws: XDocletException
See Also: HomeTagsHandler
UNKNOWN: type = "block"
Parameters: method The method to test
Returns: true if ejb.create-method tag found
Parameters: method The method to test
Returns: true if name starts with ejbFind
Parameters: method The method to test
Returns: true if ejb.home-method tag found
Parameters: method The method to test
Returns: true if named ejbRemove
Parameters: attributes
Returns: Description of the Returned Value
Throws: XDocletException
UNKNOWN: type = "content" name = "type" optional = "false" values = "remote,local" description = "Specifies if we want * the jndi name value for local or remote lookup."
Parameters: tag The XTag to check type The desired view-type
Returns: true if the tag's view-type is compatible
Parameters: tags Collection of XTag to be checked. type The desired view-type
Returns: true if all tags' view-type parameters are compatible
Returns: comma-separated parameter list
Throws: XDocletException
UNKNOWN: type = "content"
Returns: comma-separated parameter list
Throws: XDocletException
UNKNOWN: type = "content" i18n
Parameters: es The new CurrentExceptions value
Parameters: cs The new CurrentSignature value
Parameters: clazz Describe what the parameter does tag_name Describe what the parameter does
Returns: Describe the return value
Throws: XDocletException
Parameters: methodName Method name to be converted.
Returns: Equivalent home interface method name.
Parameters: methodName Method name to be converted.
Returns: Equivalent home interface method name.
Parameters: methodName Method name to be converted.
Returns: Equivalent home interface method name.