homeinterface

Generates remote home interfaces for EJBs.

Implementing Class

xdoclet.modules.ejb.home.HomeInterfaceSubTask

Attributes

AttributeDescriptionRequired
patternThe pattern by which the home interfaces are named. The placeholder "{0}" designates the EJB name. No, defaults to {0}Home
acceptInterfacesIndicates whether or not to generate for interfaces. No, default is "true"
acceptAbstractClassesIndicates whether or not to generate for abstract classes. No, default is "true"
packageSubstitutionsSets the PackageSubstitutions attribute of the TemplateSubTask object No.
packageSubstitutionInheritanceSupportedIndicates whether or not package substitution should be inherited No, default is "true"
prefixWithPackageStructureIndicates whether or not to prefix with package structure. No, default is "true"
destinationFileThe destination file name. If a {0} is found it's assumed that a per class output generation is needed, so {0} is substituted with class name; otherwise a single file is generated with the specified name. No, default is determined by this task.
templateFileSets the name of the template file to use for generation No, default is determined by this task.
havingClassTagSets the HavingClassTag attribute of the TemplateSubTask object No.
ofType No.
subTaskNameSets an optional name for the subtask that will be seen in XDoclet's debug messages. No.
destDirSets the directory where the generated file(s) will be written. No.
mergeDirSpecifies the location of the merge directory. This is where XDoclet will look for merge files. No.

Merge Files

File nameDescriptionRelates to
home-custom.xdtA text file containing custom template and/or java code to include in the home interface.{0}Home.java

Nested Elements

ElementDescription
configParamSpecifies a configuration parameter for the subtask.
ofType
packageSubstitutionSubstitutes the package of the generated files.