xdoclet.modules.jdo
Class JdoTagsHandler
java.lang.Object
xdoclet.template.TemplateTagHandler
xdoclet.XDocletTagSupport
xdoclet.modules.jdo.JdoTagsHandler
public class JdoTagsHandler
extends xdoclet.XDocletTagSupport
- Ludovic Claude (ludovicc@users.sourceforge.net)
- David Jencks (d_jencks@users.sourceforge.net)
void | forAllClassesInPackage(String template, Properties attributes) - The
forAllClassesInPackage method iterates through all the classes in the current package.
|
void | forAllPackages(String template, Properties attributes) - The
forAllPackages iterates through all packages, and generates the template if the
jdo.persistence-capable tag is present in at least one class in the package.
|
void | forAllVendorExtensions(String template, Properties attributes) - Generates the tag body for each vendor extension at the specified level.
|
protected void | setCurrentVendorExtension(VendorExtension vendorExtension)
|
String | vendorExtension(Properties attributes) - Generates the extension element for the current vendor extension.
|
delimit , expandClassName , generate , getCurrentClass , getCurrentClassTag , getCurrentConstructor , getCurrentField , getCurrentFieldTag , getCurrentMethod , getCurrentMethodTag , getCurrentPackage , getDocletContext , getEngine , getExpandedDelimitedTagValue , getTagValue , getTagValue , getTagValue , hasHavingClassTag , hasTag , isTagValueEqual , mandatoryParamNotFound , mandatoryTemplateTagParamNotFound , modifiers , popCurrentClass , pushCurrentClass , setCurrentClass , setCurrentClassTag , setCurrentConstructor , setCurrentField , setCurrentFieldTag , setCurrentMethod , setCurrentMethodTag , setCurrentPackage |
forAllClassesInPackage
public void forAllClassesInPackage(String template,
Properties attributes)
throws xdoclet.XDocletException
The forAllClassesInPackage
method iterates through all the classes in the current package.
template
- a String
valueattributes
- a Properties
value
xdoclet.XDocletException
- if an error occurs @doc:tag type="block"
forAllPackages
public void forAllPackages(String template,
Properties attributes)
throws xdoclet.XDocletException
The forAllPackages
iterates through all packages, and generates the template if the
jdo.persistence-capable tag is present in at least one class in the package.
template
- a String
valueattributes
- a Properties
value
xdoclet.XDocletException
- if an error occurs @doc:tag type="block" @doc:param name="tagName" optional="false"
description="The tag name that must be present in at least one class in the package in order that the
template be generated."
forAllVendorExtensions
public void forAllVendorExtensions(String template,
Properties attributes)
throws xdoclet.XDocletException
Generates the tag body for each vendor extension at the specified level.
xdoclet.XDocletException
-
- name = "level"
optional = "false"
values = "class,field,collection,array,map"
description = "The level to generate the extension tags for."
setCurrentVendorExtension
protected void setCurrentVendorExtension(VendorExtension vendorExtension)
vendorExtension
public String vendorExtension(Properties attributes)
Generates the extension element for the current vendor extension.
- Current <extension> element.