localhomeinterface

Generates local home interfaces for EJBs.

Implementing Class

xdoclet.modules.ejb.home.LocalHomeInterfaceSubTask

Attributes

Attribute Description Required
pattern The pattern by which the local home interfaces are named. The placeholder "{0}" designates the EJB name. No,defaultsto {0}LocalHome
acceptInterfaces Indicates whether or not to generate for interfaces. "No, default is 'true'"
acceptAbstractClasses Indicates whether or not to generate for abstract classes. "No, default is 'true'"
packageSubstitutions Sets the PackageSubstitutions attribute of the TemplateSubTask object No.
packageSubstitutionInheritanceSupported Indicates whether or not package substitution should be inherited "No, default is 'true'"
prefixWithPackageStructure Indicates whether or not to prefix with package structure. "No, default is 'true'"
destinationFile The 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,defaultis determinedbythis task.
templateFile Sets the name of the template file to use for generation No,defaultis determinedbythis task.
havingClassTag Sets the HavingClassTag attribute of the TemplateSubTask object No.
ofType No.
subTaskName Sets an optional name for the subtask that will be seen in XDoclet's debug messages. No.
destDir Sets the directory where the generated file(s) will be written. No.
mergeDir Specifies the location of the merge directory. This is where XDoclet will look for merge files. No.

Merge Files

File name Description Relates to
local-home-custom.xdt A text file containing custom template and/or java code to include in the local home interface. {0}LocalHome.java

Nested Elements

Element Description
configParam Specifies a configuration parameter for the subtask.
ofType
packageSubstitution Substitutes the package of the generated files.