xdoclet.modules.jdo

Class JdoTagsHandler

public class JdoTagsHandler extends XDocletTagSupport

Version: $Revision: 1.10 $

Author: Ludovic Claude (ludovicc@users.sourceforge.net) David Jencks (d_jencks@users.sourceforge.net)

UNKNOWN: June 11, 20012 namespace = "Jdo"

Method Summary
voidforAllClassesInPackage(String template, Properties attributes)
The forAllClassesInPackage method iterates through all the classes in the current package.
voidforAllPackages(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.
voidforAllVendorExtensions(String template, Properties attributes)
Generates the tag body for each vendor extension at the specified level.
protected voidsetCurrentVendorExtension(VendorExtension vendorExtension)
StringvendorExtension(Properties attributes)
Generates the extension element for the current vendor extension.

Method Detail

forAllClassesInPackage

public void forAllClassesInPackage(String template, Properties attributes)
The forAllClassesInPackage method iterates through all the classes in the current package.

Parameters: template a String value attributes a Properties value

Throws: XDocletException if an error occurs @doc:tag type="block"

forAllPackages

public 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.

Parameters: template a String value attributes a Properties value

Throws: 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)
Generates the tag body for each vendor extension at the specified level.

Parameters: template attributes

Throws: XDocletException

UNKNOWN: type = "block" 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.

Parameters: attributes

Returns: Current <extension> element.

UNKNOWN: type = "content"