xdoclet.modules.ejb.lookup

Class LookupObjectSubTask


public class LookupObjectSubTask
extends AbstractEjbCodeGeneratorSubTask

Version:
$Revision: 1.13 $
Author:
Konstantin Pribluda
ant.element
display-name = "Lookup Object" name = "utilobject" parent = "xdoclet.modules.ejb.EjbDocletTask"
created
October 3, 2001

Nested Class Summary

static class
LookupObjectSubTask.LookupKind

Field Summary

static String
DEFAULT_UTIL_CLASS_PATTERN

Constructor Summary

LookupObjectSubTask()
Describe what the UtilObjectSubTask constructor does

Method Summary

protected void
engineStarted()
Describe what the method does
boolean
getCacheHomes()
Cache the homes?
protected String
getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the UtilObjectSubTask object
boolean
getIncludeGUID()
Include a performant GUID generator in the util object.
String
getKind()
Gets the Kind attribute of the UtilObjectSubTask object
boolean
getLocalProxies()
should local proxies be returned instead of home interfaces be returned for SLSBs?
String
getUtilClassPattern()
Returns the configuration parameter for specifying the utility class name pattern.
protected boolean
matchesGenerationRules(XClass clazz)
Describe what the method does
void
setCacheHomes(boolean cacheHomes)
Cache the homes?
void
setIncludeGUID(boolean includeGUID)
Include a performant GUID generator in the util object.
void
setKind(LookupObjectSubTask.LookupKind kind)
Sets the Kind attribute of the UtilObjectSubTask object
void
setLocalProxies(boolean localProxies)
Should local proxies be dynamically generated for Stateless session beans? (Typically used with Hibernate instead of Entity Beans to develop outside the container.)
void
setPattern(String new_pattern)
Sets the Pattern attribute of the UtilObjectSubTask object
void
validateOptions()
Called to validate configuration parameters.

Field Details

DEFAULT_UTIL_CLASS_PATTERN

public static final String DEFAULT_UTIL_CLASS_PATTERN

Constructor Details

LookupObjectSubTask

public LookupObjectSubTask()
Describe what the UtilObjectSubTask constructor does

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
Describe what the method does
Throws:
xdoclet.XDocletException -

getCacheHomes

public boolean getCacheHomes()
Cache the homes?
Returns:

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
            throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the UtilObjectSubTask object
Parameters:
clazz - Describe what the parameter does
Returns:
The GeneratedFileName value
Throws:
xdoclet.XDocletException -

getIncludeGUID

public boolean getIncludeGUID()
Include a performant GUID generator in the util object.
Returns:

getKind

public String getKind()
Gets the Kind attribute of the UtilObjectSubTask object
Returns:
The Kind value

getLocalProxies

public boolean getLocalProxies()
should local proxies be returned instead of home interfaces be returned for SLSBs?
Returns:

getUtilClassPattern

public String getUtilClassPattern()
Returns the configuration parameter for specifying the utility class name pattern. By default the value is used for deciding the utility name. {0} in the value mean current class's symbolic name which for an EJBean is the EJB name. If nothing explicitly specified by user then "{0}Util" is used by default.
Returns:
The UtilClassPattern value

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)
            throws xdoclet.XDocletException
Describe what the method does
Parameters:
clazz - Describe what the parameter does
Returns:
Describe the return value
Throws:
xdoclet.XDocletException -

setCacheHomes

public void setCacheHomes(boolean cacheHomes)
Cache the homes?
Parameters:
cacheHomes -

setIncludeGUID

public void setIncludeGUID(boolean includeGUID)
Include a performant GUID generator in the util object.
Parameters:
includeGUID - include the GUID generator or not

setKind

public void setKind(LookupObjectSubTask.LookupKind kind)
Sets the Kind attribute of the UtilObjectSubTask object
Parameters:
kind - The new Kind value

setLocalProxies

public void setLocalProxies(boolean localProxies)
Should local proxies be dynamically generated for Stateless session beans? (Typically used with Hibernate instead of Entity Beans to develop outside the container.)
Parameters:
localProxies -

setPattern

public void setPattern(String new_pattern)
Sets the Pattern attribute of the UtilObjectSubTask object
Parameters:
new_pattern - The new Pattern value

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
Called to validate configuration parameters.
Throws:
xdoclet.XDocletException -