Package

Implemented in class xdoclet.tagshandler.PackageTagsHandler.

Block Tags:

packageOf (block template)

Returns the not-full-qualified package name of the full-qualified class name specified in the body of this tag.

packageDeclarationOf (block template)

Writes the package declaration for the package name of the full-qualified class name specified in the body of this tag. No package declaration is written if the full-qualified class name has no package.

forAllPackages (block template)

Iterates over all packages loaded by XJavadoc. Subsequent calls to forAllClasses will only iterate over the classes in the current package.

[abstract] If true then accept abstract classes also; otherwise don't.

Valid Values = {true,false}
[type] For all classes by the type.
[extent] Specifies the extent of the type search. If concrete-type then only check the concrete type, if superclass then check also superclass, if hierarchy then search the whole hierarchy and find if the class is of the specified type. Default is hierarchy.

Valid Values = {concrete-type,superclass,hierarchy}

setMatchValue (block template)

Sets the value of match variable.

value The new value for matchPattern.

Content templates:

packageNameAsPathFor (content template)

Returns a package name as a path, after applying any substitutions.

packageNameAsPathWithoutSubstitutionFor (content template)

Returns a package name as a path, without applying any substitutions.

packageNameAsPathFor (content template)

Returns a package name as a path, after applying any substitutions.

packageName (content template)

Returns the current package name. If we're in the context of a package iteration, this is the name of the current package. If we're in the context of a class iteration without a package iteration, return the name of the current class' package.

packageNameAsPath (content template)

Returns the current package name as a path.

matchValue (content template)

Returns the value of match variable. Match variable serves as a variable for templates, you set it somewhere in template and look it up somewhere else in template.

currentToken (content template)

Returns current token inside forAllClassTagTokens.

skipToken (content template)

Skips current token. Returns empty string.