Serialized Form
name
String name
value
String value
_xJavaDoc
xjavadoc.XJavaDoc _xJavaDoc
destDir
File destDir
- Destination directory where generated files will be stored.
mergeDir
File mergeDir
- Merge directory where XDoclet searches for external files that are to be merged. Merge files internal to
xdoclet.jar are picked from xdoclet.jar's root instead of using mergeDir which is for external files. By default
it inherits its value from the shared DocletContext which is itself filled with values set by user for the task.
configParams
ArrayList configParams
subTaskName
String subTaskName
- You can explicitly give the task a distinct name. It's useful for where if you're going to use config
parameters you have to prefix the parameter with a unique subtask name, otherwise it's assumed to be a global
config parameter and it means that you can't use the same parameter name in two instances.
Overwriting it with this field explicitly gives you the chance to make the config param a local and solve the
above problem.
templateURL
URL templateURL
prefixWithPackageStructure
boolean prefixWithPackageStructure
acceptInterfaces
boolean acceptInterfaces
acceptAbstractClasses
boolean acceptAbstractClasses
docEncoding
String docEncoding
destinationFile
String destinationFile
- See Also:
TemplateSubTask.setDestinationFile(java.lang.String)
,
TemplateSubTask.getDestinationFile()
ofType
List ofType
- Applicable only to per class output generation. Specify full qualified class name from which classes should be
derived. Output generation is performed only for classes of one of the types defined in this list. You can
control the extent in which the type search occures by using 'extent' property.
- See Also:
TemplateSubTask.addOfType(java.lang.String)
,
TemplateSubTask.getOfType()
,
TemplateSubTask.setExtent(TemplateSubTask.ExtentTypes)
,
TemplateSubTask.getExtent()
extent
String extent
- You can control the extent in which the type search occurs. Valid values are: concrete-type ,
superclass and hierarchy which is the default.
- See Also:
TemplateSubTask.setExtent(TemplateSubTask.ExtentTypes)
,
TemplateSubTask.getExtent()
,
TemplateSubTask.addOfType(java.lang.String)
,
TemplateSubTask.getOfType()
havingClassTag
String havingClassTag
- A class should have the class tag defined in this property in order to be processed and output generated for.
- See Also:
TemplateSubTask.setHavingClassTag(java.lang.String)
,
TemplateSubTask.getHavingClassTag()
subTaskClassName
String subTaskClassName
- The subtask class.
packageSubstitutions
ArrayList packageSubstitutions
packageSubstitutionInheritanceSupported
boolean packageSubstitutionInheritanceSupported
generationManager
GenerationManager generationManager
useIds
boolean useIds
xmlEncoding
String xmlEncoding
validateXML
boolean validateXML
- Flag that indicates whether validation of generated XML should occur.
publicId
String publicId
systemId
String systemId
dtdURL
URL dtdURL
schema
String schema
schemaURL
URL schemaURL
Package xdoclet.tagshandler |
packages
String packages
substituteWith
String substituteWith
useFirst
boolean useFirst
nestedException
Exception nestedException
Package xdoclet.modules.maven |
Package xdoclet.modules.externalizer |
tagName
String tagName
valueParamName
String valueParamName
combinations
Map combinations
currentCombination
ExternalizerSubTask.Combination currentCombination
Package xdoclet.modules.doc |
classToAntElementMap
Map classToAntElementMap
- Usually, one class corresponds to only one XML element, but in some rare cases it might correspond to more. This
is if the same class is used in e.g. several create methods:
Gee createFoo()
, Gee createBar()
The Gee class corresponds to <foo> AND <bar>. This map's values are Sets containing AntElements.
alreadyRecursed
Set alreadyRecursed
currentNamespace
String currentNamespace
Package xdoclet.modules.doc.info |
properties
Properties properties
header
String header
projectName
String projectName
Package xdoclet.modules.ejb |
Package xdoclet.modules.ejb.lookup |
utilClassPattern
String utilClassPattern
- A 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.
- See Also:
LookupObjectSubTask.getUtilClassPattern()
includeGUID
boolean includeGUID
- Include a performant GUID generator in the util object.
cacheHomes
boolean cacheHomes
- Cache the homes?
kind
String kind
- The preferred kind of lookup code, which is either logical or physical.
localProxies
boolean localProxies
- should local proxies to session beans be generated
Package xdoclet.modules.ejb.dd |
description
String description
displayname
String displayname
smallicon
String smallicon
largeicon
String largeicon
clientjar
String clientjar
Package xdoclet.modules.ejb.intf |
localClassPattern
String localClassPattern
- A configuration parameter for specifying the local interface name pattern. By default the value is used for
deciding the local interface name. The placeholder "{0}" in the value means the current class's symbolic name
which for an EJBean is the EJB name.
- See Also:
LocalInterfaceSubTask.getLocalClassPattern()
remoteClassPattern
String remoteClassPattern
- A configuration parameter for specifying the remote interface name pattern. By default the value is used for
deciding the remote interface name. The placeholder "{0}" in the value means the current class's symbolic name
which for an EJBean is the EJB name.
- See Also:
RemoteInterfaceSubTask.getRemoteClassPattern()
serviceEndpointClassPattern
String serviceEndpointClassPattern
- A configuration parameter for specifying the service-endpoint interface name pattern. By default the value is
used for deciding the service-endpoint interface name. {0} in the value mean current class's symbolic name which
for an EJBean is the EJB name.
- See Also:
ServiceEndpointSubTask.getServiceEndpointClassPattern()
Package xdoclet.modules.ejb.mdb |
mdbClassPattern
String mdbClassPattern
- A configuration parameter for specifying the concrete mdb bean class name pattern. By default the value is used
for deciding the concrete mdb bean class name. {0} in the value mean current class's symbolic name which for an
EJBean is the EJB name.
- See Also:
MdbSubTask.getMessageDrivenClassPattern()
Package xdoclet.modules.ejb.entity |
dataObjectClassPattern
String dataObjectClassPattern
- A configuration parameter for specifying the data object class name pattern. By default the value is used for
deciding the entity data object class name. {0} in the value mean current class's symbolic name which for an
EJBean is the EJB name.
- See Also:
DataObjectSubTask.getDataObjectClassPattern()
entityBmpClassPattern
String entityBmpClassPattern
- A configuration parameter for specifying the concrete BMP entity bean class name pattern. By default the value is
used for deciding the concrete BMP entity bean class name. The placeholder "{0}" in the value means the current
class's symbolic name which for an EJBean is the EJB name.
- See Also:
EntityBmpSubTask.getEntityBmpClassPattern()
entityCmpClassPattern
String entityCmpClassPattern
- A configuration parameter for specifying the concrete CMP entity bean class name pattern. By default the value is
used for deciding the concrete CMP entity bean class name. {0} in the value mean current class's symbolic name
which for an EJBean is the EJB name.
- See Also:
EntityCmpSubTask.getEntityCmpClassPattern()
cmpspec
String cmpspec
entityFacadeClassPattern
String entityFacadeClassPattern
- A configuration parameter for specifying the entity bean facade EJB class name pattern. By default the value is
used for deciding the entity bean facade class name. {0} in the value mean current class's symbolic name which
for an EJBean is the EJB name.
entityFacadeEjbNamePattern
String entityFacadeEjbNamePattern
- a configuration parameter for specifying facade ejb names pattern {0} means ejb name
entityPkClassPattern
String entityPkClassPattern
- A configuration parameter for specifying the entity bean primary class name pattern. By default the value is used
for deciding the entity bean primary class name. The placeholder "{0}" in the value means the current class's
symbolic name which for an EJBean is the EJB name.
- See Also:
EntityPkSubTask.getEntityPkClassPattern()
valueObjectClassPattern
String valueObjectClassPattern
- A configuration parameter for specifying the data object class name pattern. By default the value is used for
deciding the entity data object class name. The placeholder "{0}" in the value means the current class's symbolic
name which for an EJBean is the EJB name.
- See Also:
ValueObjectSubTask.getValueObjectClassPattern()
currentDataObjectTag
xjavadoc.XTag currentDataObjectTag
- Form tag being processed right now
generatePKConstructor
boolean generatePKConstructor
- Whether to generate a single-parameter constructor, only setting up the PK
Package xdoclet.modules.ejb.dao |
daoClassPattern
String daoClassPattern
- A configuration parameter for specifying the DAO class name pattern. By default the value is used for deciding
the DAO class name. {0} in the value mean current class's symbolic name which for an EJBean is the EJB name.
- See Also:
DaoSubTask.getDaoClassPattern()
Package xdoclet.modules.ejb.session |
remoteFacadeClassPattern
String remoteFacadeClassPattern
- A configuration parameter for specifying the entity bean facade EJB class name pattern. By default the value is
used for deciding the entity bean facade class name. {0} in the value mean current class's symbolic name which
for an EJBean is the EJB name.
remoteFacadeEjbNamePattern
String remoteFacadeEjbNamePattern
- a configuration parameter for specifying facade ejb names pattern {0} means ejb name
sessionClassPattern
String sessionClassPattern
- A configuration parameter for specifying the concrete session bean class name pattern. By default the value is
used for deciding the concrete session bean class name. {0} in the value mean current class's symbolic name which
for an EJBean is the EJB name.
- See Also:
SessionSubTask.getSessionClassPattern()
Package xdoclet.modules.ejb.home |
homeClassPattern
String homeClassPattern
- A configuration parameter for specifying the home interface name pattern. By default the value is used for
deciding the home interface name. The placeholder "{0}" in the value means the current class's symbolic name
which for an EJBean is the EJB name.
- See Also:
HomeInterfaceSubTask.getHomeClassPattern()
localHomeClassPattern
String localHomeClassPattern
- A configuration parameter for specifying the local home interface name pattern. By default the value is used for
deciding the local home interface name. The placeholder "{0}" in the value means the current class's symbolic
name which for an EJBean is the EJB name.
- See Also:
LocalHomeInterfaceSubTask.getLocalHomeClassPattern()
Package xdoclet.modules.hp.hpas.ejb |
sfsbPassivationRoot
String sfsbPassivationRoot
persistenceProduct
String persistenceProduct
persistenceVersion
String persistenceVersion
persistenceClass
String persistenceClass
persistenceSuffix
String persistenceSuffix
Package xdoclet.modules.sybase.easerver.ejb |
packageName
String packageName
- Name of the Jaguar Package in the Repository that the EJBs will be deployed to.
packageDescription
String packageDescription
- Description of the Jaguar Package in the Repository.
version
String version
- The Jaguar version.
Package xdoclet.modules.jmx |
Package xdoclet.modules.mx4j |
Package xdoclet.modules.sun.sunone.ejb |
version
String version
- The iPlanet/SunONE version.
transactionManagerType
String transactionManagerType
- Optional transaction manager type.
cmpResourceJndiName
String cmpResourceJndiName
- Optional CMP Resource JNDI name.
cmpResourcePrincipalName
String cmpResourcePrincipalName
- Optional CMP Resource Principal name.
cmpResourcePrincipalPassword
String cmpResourcePrincipalPassword
- Optional CMP Resource Principal password.
cmpSchema
String cmpSchema
- CMP Schema filename (without .dbschema extension), produced by Sun's utilities
cmpTemplateFile
String cmpTemplateFile
cmpDestinationFile
String cmpDestinationFile
Package xdoclet.modules.web |
taglibversion
String taglibversion
jspversion
String jspversion
shortname
String shortname
uri
String uri
displayname
String displayname
smallicon
String smallicon
largeicon
String largeicon
description
String description
filename
String filename
serviceEndpointClassPattern
String serviceEndpointClassPattern
- A configuration parameter for specifying the service-endpoint interface name pattern. By default the value is
used for deciding the service-endpoint interface name. {0} in the value mean current class's symbolic name which
for an EJBean is the EJB name.
- See Also:
ServiceEndpointSubTask.getServiceEndpointClassPattern()
servletSpec
String servletSpec
smallIcon
String smallIcon
largeIcon
String largeIcon
displayName
String displayName
description
String description
distributable
boolean distributable
contextParams
ArrayList contextParams
sessionTimeout
Integer sessionTimeout
welcomeFiles
ArrayList welcomeFiles
tagLibs
ArrayList tagLibs
paramName
String paramName
paramValue
String paramValue
description
String description
taglibUri
String taglibUri
taglibLocation
String taglibLocation
file
String file
Package xdoclet.modules.jboss.jmx |
servicefile
String servicefile
Package xdoclet.modules.jboss.web |
securityDomain
String securityDomain
- The Security Domain, defaults to "" because it is not included if not set in the build.xml.
contextRoot
String contextRoot
- The Context Root, defaults to "" because it is not included if not set in the build.xml.
virtualHost
String virtualHost
- The Virtual Host, defaults to "" because it is not included if not set in the build.xml.
version
String version
- The JBoss version to target. Possible subversion are the values present in JBossSubTask.JBossVersionTypes
Package xdoclet.modules.jboss.ejb |
version
String version
datasource
String datasource
datasourceMapping
String datasourceMapping
generateRelations
String generateRelations
preferredRelationMapping
String preferredRelationMapping
createTable
String createTable
alterTable
String alterTable
removeTable
String removeTable
securityDomain
String securityDomain
webServiceContextRoot
String webServiceContextRoot
unauthenticatedPrincipal
String unauthenticatedPrincipal
debug
String debug
jbossTemplateURL
URL jbossTemplateURL
jawsTemplateURL
URL jawsTemplateURL
jbosscmpTemplateURL
URL jbosscmpTemplateURL
Package xdoclet.modules.ibm.websphere.ejb |
datasource
String datasource
- A member for the default CMP DataSource
currentBackendId
String currentBackendId
- A member for the current backend id
Package xdoclet.modules.ibm.websphere.web |
hasTransformedWebXml
boolean hasTransformedWebXml
- Flag indicating whether we've styled the web.xml file
virtualHostName
String virtualHostName
- See Also:
WebSphereWebXmlSubTask.setVirtualHostName(String)
reloadInterval
String reloadInterval
- See Also:
WebSphereWebXmlSubTask.setReloadInterval(String)
reloadingEnabled
String reloadingEnabled
- See Also:
WebSphereWebXmlSubTask.setReloadingEnabled(String)
defaultErrorPage
String defaultErrorPage
- See Also:
WebSphereWebXmlSubTask.setDefaultErrorPage(String)
additionalClassPath
String additionalClassPath
- See Also:
WebSphereWebXmlSubTask.setAdditionalClassPath(String)
fileServingEnabled
String fileServingEnabled
- See Also:
WebSphereWebXmlSubTask.setFileServingEnabled(String)
directoryBrowsingEnabled
String directoryBrowsingEnabled
- See Also:
WebSphereWebXmlSubTask.setDirectoryBrowsingEnabled(String)
serveServletsByClassnameEnabled
String serveServletsByClassnameEnabled
- See Also:
WebSphereWebXmlSubTask.setServeServletsByClassnameEnabled(String)
preCompileJSPs
String preCompileJSPs
- See Also:
WebSphereWebXmlSubTask.setPreCompileJSPs(String)
autoRequestEncoding
String autoRequestEncoding
- See Also:
WebSphereWebXmlSubTask.setAutoRequestEncoding(String)
autoResponseEncoding
String autoResponseEncoding
- See Also:
WebSphereWebXmlSubTask.setAutoResponseEncoding(String)
autoLoadFilters
String autoLoadFilters
- See Also:
WebSphereWebXmlSubTask.setAutoLoadFilters(String)
Package xdoclet.modules.openejb.ejb |
openEJBTemplateFile
String openEJBTemplateFile
OPENEJB_DTD_FILE_NAME
String OPENEJB_DTD_FILE_NAME
Package xdoclet.modules.caucho |
cacheSize
String cacheSize
cacheTimeout
String cacheTimeout
generateSourceComments
String generateSourceComments
appDir
String appDir
classUpdateInterval
String classUpdateInterval
configUpdateInterval
String configUpdateInterval
directoryServlet
String directoryServlet
encoding
String encoding
id
String id
lazyInit
String lazyInit
secure
String secure
tempDir
String tempDir
urlRegexp
String urlRegexp
workDir
String workDir
generateSourceComments
String generateSourceComments
searchForConfigElements
String searchForConfigElements
useStandardMergeFiles
String useStandardMergeFiles
Package xdoclet.modules.borland.bes.ejb |
_version
String _version
_datasource
String _datasource
_datasourceMapping
String _datasourceMapping
_createTables
boolean _createTables
Package xdoclet.modules.macromedia.jrun.web |
contextRoot
String contextRoot
- The Security Domain, defaults to "" because it is not included if not set in the build.xml.
reload
String reload
compile
String compile
loadSystemClassesFirst
String loadSystemClassesFirst
Package xdoclet.modules.macromedia.jrun.ejb |
_version
String _version
_dataSource
String _dataSource
_createTables
boolean _createTables
Package xdoclet.modules.webwork |
javadocDir
String javadocDir
Package xdoclet.modules.jdo |
jdoSpec
String jdoSpec
generation
String generation
forceGenerationPerPackage
boolean forceGenerationPerPackage
project
String project
Package xdoclet.modules.apache.struts |
formClassPattern
String formClassPattern
- The pattern for the form class. Defaults to {0}{1}Form if not present.
currentFormTag
xjavadoc.XTag currentFormTag
- Form tag being processed right now.
strutsVersion
String strutsVersion
- Defaults to Struts 1.0.
controller
String controller
- Sets the controller that the struts application should use. Valid for version 1.1
version
String version
Package xdoclet.modules.apache.struts.ejb |
formClassPattern
String formClassPattern
- The pattern for the form class. Defaults to {0}{1}Form if not present.
currentFormTag
xjavadoc.XTag currentFormTag
- Form tag being processed right now.
Package xdoclet.modules.apache.axis.ejb |
contextFactoryName
String contextFactoryName
contextProviderUrl
String contextProviderUrl
Package xdoclet.modules.apache.tapestry |
Package xdoclet.modules.apache.soap.ejb |
statelessSessionEjbProvider
String statelessSessionEjbProvider
statefulSessionEjbProvider
String statefulSessionEjbProvider
entityEjbProvider
String entityEjbProvider
providerClasspath
org.apache.tools.ant.types.Path providerClasspath
contextProviderUrl
String contextProviderUrl
contextFactoryName
String contextFactoryName
Package xdoclet.modules.bea.wls.ejb |
version
String version
dataSource
String dataSource
poolName
String poolName
createTables
String createTables
persistence
String persistence
validateDbSchemaWith
String validateDbSchemaWith
databaseType
String databaseType
orderDatabaseOperations
boolean orderDatabaseOperations
enableBatchOperations
boolean enableBatchOperations
enableBeanClassRedeploy
boolean enableBeanClassRedeploy
ejbJarXml
URL ejbJarXml
cmpRdbmsJarXml
URL cmpRdbmsJarXml
Package xdoclet.modules.bea.wls.web |
securityDomain
String securityDomain
- The Security Domain, defaults to "" because it is not included if not set in the build.xml.
description
String description
- The description of the Web App.
contextRoot
String contextRoot
- The web app's context root (overrides any value in application.xml)
version
String version
- The WLS version.
Package xdoclet.modules.spring |
defaultAutowire
String defaultAutowire
defaultLazyInit
String defaultLazyInit
defaultDependencyCheck
String defaultDependencyCheck
Package xdoclet.modules.java.javabean |
i18nGeneration
boolean i18nGeneration
- Is the BeanInfo class built for I18N
Package xdoclet.modules.wsee |
smallIcon
String smallIcon
- state
largeIcon
String largeIcon
displayName
String displayName
description
String description
name
String name
prefixWithPackageStructure
boolean prefixWithPackageStructure
packages
String packages
namespace
String namespace
Package xdoclet.modules.triactive.jdo |
version
String version
Package xdoclet.modules.solarmetric.jdo |
version
String version
Package xdoclet.modules.exolab.castor.ejb |
Package xdoclet.modules.jsf |
version
String version
messageBundle
String messageBundle
defaultLocale
String defaultLocale
supportedLocales
String supportedLocales
currentSupportedLocale
String currentSupportedLocale
Package xdoclet.modules.portlet |
Package xdoclet.modules.hibernate |
dataSource
String dataSource
dialect
String dialect
driver
String driver
username
String username
password
String password
factoryClass
String factoryClass
useJndiFactory
boolean useJndiFactory
jndiName
String jndiName
jdbcUrl
String jdbcUrl
poolSize
String poolSize
hibernateVersion
String hibernateVersion
jndiName
String jndiName
dataSource
String dataSource
dialect
String dialect
useOuterJoin
boolean useOuterJoin
showSql
boolean showSql
userName
String userName
password
String password
userTransactionName
String userTransactionName
transactionManagerStrategy
String transactionManagerStrategy
driver
String driver
jdbcUrl
String jdbcUrl
poolSize
String poolSize
transactionManagerLookup
String transactionManagerLookup
jndiProperties
ArrayList jndiProperties
otherProperties
List otherProperties
defaultSchema
String defaultSchema
cglibUseReflectionOptimizer
String cglibUseReflectionOptimizer
cacheProviderClass
String cacheProviderClass
transactionManagerFactory
String transactionManagerFactory
hbm2ddl
String hbm2ddl
otherMappings
List otherMappings
hibernateVersion
String hibernateVersion
- Defaults to Hibernate 1.1.
_jndiName
String _jndiName
_dataSource
String _dataSource
_dialect
String _dialect
_serviceName
String _serviceName
_useOuterJoin
boolean _useOuterJoin
_showSql
boolean _showSql
_userName
String _userName
_password
String _password
_userTransactionName
String _userTransactionName
_transactionStrategy
String _transactionStrategy
_cacheProvider
String _cacheProvider
_depends
String _depends
_transactionManagerStrategy
String _transactionManagerStrategy
_maxFetchDepth
String _maxFetchDepth
_jdbcFetchSize
String _jdbcFetchSize
_useQueryCache
String _useQueryCache
_querySubstitutions
String _querySubstitutions
_defaultSchema
String _defaultSchema
_autoCreate
String _autoCreate
_version
String _version
Package xdoclet.modules.pramati.ejb |
_version
String _version
_dataSource
String _dataSource
_jarName
String _jarName
Package xdoclet.modules.oracle.oc4j.ejb |
deploymentVersion
String deploymentVersion
Package xdoclet.modules.objectweb.jonas.ejb |
version
String version
- JOnAS version to generate files for.
Package xdoclet.modules.objectweb.jonas.web |
version
String version
- JOnAS version to generate files for.
host
String host
- The host element specifies the name of host used for deploy the web application.
contextRoot
String contextRoot
- The context-root element specifies the context root for the web application.
Package xdoclet.modules.mvcsoft.ejb |
deploymentVersion
String deploymentVersion
connectionJndiName
String connectionJndiName
loggingType
String loggingType
lightweightFactoryName
String lightweightFactoryName
Package xdoclet.modules.libelis.jdo |
version
String version
Package xdoclet.modules.mockobjects |
mockClassPattern
String mockClassPattern
Package xdoclet.modules.orion.ejb |
version
String version