xdoclet.modules.ejb.lookup

Class LookupObjectSubTask

public class LookupObjectSubTask extends AbstractEjbCodeGeneratorSubTask

Version: $Revision: 1.13 $

Author: Konstantin Pribluda

UNKNOWN: October 3, 2001 display-name = "Lookup Object" name = "utilobject" parent = "xdoclet.modules.ejb.EjbDocletTask" file = "util-custom.xdt" relates-to = "{0}Util.java" description = "A text file containing custom * template and/or java code to include in the utility class." file = "lookup-custom.xdt" relates-to = "{0}Util.java" description = "A text file containing custom * template and/or java code to include in the utility class."

Nested Class Summary
static classLookupObjectSubTask.LookupKind
Field Summary
static StringDEFAULT_UTIL_CLASS_PATTERN
Constructor Summary
LookupObjectSubTask()
Describe what the UtilObjectSubTask constructor does
Method Summary
protected voidengineStarted()
Describe what the method does
booleangetCacheHomes()
Cache the homes?
protected StringgetGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the UtilObjectSubTask object
booleangetIncludeGUID()
Include a performant GUID generator in the util object.
StringgetKind()
Gets the Kind attribute of the UtilObjectSubTask object
booleangetLocalProxies()
should local proxies be returned instead of home interfaces be returned for SLSBs?
StringgetUtilClassPattern()
Returns the configuration parameter for specifying the utility class name pattern.
protected booleanmatchesGenerationRules(XClass clazz)
Describe what the method does
voidsetCacheHomes(boolean cacheHomes)
Cache the homes?
voidsetIncludeGUID(boolean includeGUID)
Include a performant GUID generator in the util object.
voidsetKind(LookupObjectSubTask.LookupKind kind)
Sets the Kind attribute of the UtilObjectSubTask object
voidsetLocalProxies(boolean localProxies)
Should local proxies be dynamically generated for Stateless session beans?
voidsetPattern(String new_pattern)
Sets the Pattern attribute of the UtilObjectSubTask object
voidvalidateOptions()
Called to validate configuration parameters.

Field Detail

DEFAULT_UTIL_CLASS_PATTERN

public static final String DEFAULT_UTIL_CLASS_PATTERN

Constructor Detail

LookupObjectSubTask

public LookupObjectSubTask()
Describe what the UtilObjectSubTask constructor does

Method Detail

engineStarted

protected void engineStarted()
Describe what the method does

Throws: XDocletException

getCacheHomes

public boolean getCacheHomes()
Cache the homes?

Returns:

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the UtilObjectSubTask object

Parameters: clazz Describe what the parameter does

Returns: The GeneratedFileName value

Throws: 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)
Describe what the method does

Parameters: clazz Describe what the parameter does

Returns: Describe the return value

Throws: 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()
Called to validate configuration parameters.

Throws: XDocletException