xdoclet.modules.ejb.lookup
public class LookupObjectSubTask extends AbstractEjbCodeGeneratorSubTask
Modifier and Type | Class and Description |
---|---|
static class |
LookupObjectSubTask.LookupKind |
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_UTIL_CLASS_PATTERN |
currentClassTag, currentFieldTag, currentMethodTag
Constructor and Description |
---|
LookupObjectSubTask()
Describe what the UtilObjectSubTask constructor does
|
Modifier and Type | Method and Description |
---|---|
protected void |
engineStarted()
Describe what the method does
|
boolean |
getCacheHomes()
Cache the homes?
|
protected java.lang.String |
getGeneratedFileName(xjavadoc.XClass clazz)
Gets the GeneratedFileName attribute of the UtilObjectSubTask object
|
boolean |
getIncludeGUID()
Include a performant GUID generator in the util object.
|
java.lang.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?
|
java.lang.String |
getUtilClassPattern()
Returns the configuration parameter for specifying the utility class name pattern.
|
protected boolean |
matchesGenerationRules(xjavadoc.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(java.lang.String new_pattern)
Sets the Pattern attribute of the UtilObjectSubTask object
|
void |
validateOptions()
Called to validate configuration parameters.
|
addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, execute, generateForClass, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, getGenerationManager, getHavingClassTag, getOfType, getPackageSubstitutions, getSubTaskClassName, getTemplateURL, init, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, processInnerClasses, setAcceptAbstractClasses, setAcceptInterfaces, setDestinationFile, setEngine, setExtent, setExtentValue, setGenerationManager, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcess, startProcessForAll, startProcessPerClass
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName
getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
public static final java.lang.String DEFAULT_UTIL_CLASS_PATTERN
public LookupObjectSubTask()
public boolean getLocalProxies()
public java.lang.String getKind()
public boolean getIncludeGUID()
public boolean getCacheHomes()
public java.lang.String getUtilClassPattern()
public void setLocalProxies(boolean localProxies)
localProxies
- public void setKind(LookupObjectSubTask.LookupKind kind)
kind
- The new Kind valuepublic void setPattern(java.lang.String new_pattern)
new_pattern
- The new Pattern valuepublic void setIncludeGUID(boolean includeGUID)
includeGUID
- include the GUID generator or notpublic void setCacheHomes(boolean cacheHomes)
cacheHomes
- public void validateOptions() throws XDocletException
validateOptions
in class TemplateSubTask
XDocletException
protected java.lang.String getGeneratedFileName(xjavadoc.XClass clazz) throws XDocletException
getGeneratedFileName
in class TemplateSubTask
clazz
- Describe what the parameter doesXDocletException
protected void engineStarted() throws XDocletException
engineStarted
in class TemplateSubTask
XDocletException
protected boolean matchesGenerationRules(xjavadoc.XClass clazz) throws XDocletException
matchesGenerationRules
in class TemplateSubTask
clazz
- Describe what the parameter doesXDocletException