xdoclet.tags
Class PackageTagsHandler

java.lang.Object
  |
  +--xdoclet.template.TemplateTagHandler
        |
        +--xdoclet.XDocletTagSupport
              |
              +--xdoclet.tags.AbstractProgramElementTagsHandler
                    |
                    +--xdoclet.tags.PackageTagsHandler

public class PackageTagsHandler

extends AbstractProgramElementTagsHandler

Version:

$Revision: 1.8 $

Author:

Ara Abrahamian (ara_e@email.com)

Inner Class Summary

static class

PackageTagsHandler.PackageSubstitution

Fields inherited from class xdoclet.tags.AbstractProgramElementTagsHandler

currentToken, matchPattern, tagTokenizer

Fields inherited from class xdoclet.XDocletTagSupport

FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER

Constructor Summary

PackageTagsHandler()

Method Summary

void	forAllPackages(java.lang.String template, java.util.Properties attributes) Iterates over all packages loaded by javadoc.
static java.lang.String	getPackageNameFor(com.sun.javadoc.PackageDoc pak)
static java.lang.String	getPackageNameFor(java.lang.String packageName) It applies package substitutions.
static java.util.Vector	getPackageSubstitutions(java.lang.String subtask_name)
java.lang.String	packageName() Returns the current package name.
java.lang.String	packageNameAsPath() Returns the current package name as path
static java.lang.String	packageNameAsPathFor(com.sun.javadoc.PackageDoc pak) Returns the current package name as path
static java.lang.String	packageNameAsPathFor(java.lang.String qualified_name) Returns the current package name as path
void	packageOf(java.lang.String template) Returns the not-full-qualified package name of the full-qualified class name specified in the body of this tag.

Methods inherited from class xdoclet.tags.AbstractProgramElementTagsHandler

checkForWrap, currentToken, exceptionList, forAllMembers, forAllMemberTags, forAllMemberTagTokens, getAllClasses, getClassNameFor, getExecutableMemberDocForMemberName, getExecutableMemberDocForMemberName, getFullClassNameFor, getFullSuperclassNameFor, getIndentChars, hasExecutableMember, ifHasTag_Impl, ifTagValueEquals_Impl, matchValue, memberComment, setMatchValue, skipToken

Methods inherited from class xdoclet.XDocletTagSupport

getClassTagValue, getClassTagValue, getConstructorTagValue, getCurrentClass, getCurrentConstructor, getCurrentField, getCurrentMethod, getCurrentPackage, getCurrentTag, getDocletContext, getFieldTagValue, getFieldTagValue, getMethodTagValue, getMethodTagValue, getParameterValue, getParameterValue, getTagValue, getTagValue, getTagValue, invalidParamValueFound, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, parsePropertyString, popCurrentClass, pushCurrentClass, replaceProperties, setCurrentClass, setCurrentConstructor, setCurrentField, setCurrentMethod, setCurrentPackage, setCurrentTag, tokenizeValue

Methods inherited from class xdoclet.template.TemplateTagHandler

generate, getContext, getEngine, getParser, setContext, setEngine, setParser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PackageTagsHandler

public PackageTagsHandler()

Method Detail

getPackageNameFor

public static java.lang.String getPackageNameFor(com.sun.javadoc.PackageDoc pak)

getPackageNameFor

public static java.lang.String getPackageNameFor(java.lang.String packageName)

It applies package substitutions.

Parameters:

packageName -

Returns:

The package name after substitutions.

getPackageSubstitutions

public static java.util.Vector getPackageSubstitutions(java.lang.String subtask_name)

packageNameAsPathFor

public static java.lang.String packageNameAsPathFor(com.sun.javadoc.PackageDoc pak)

Returns the current package name as path

Parameters:

pak - Description of Parameter

Returns:

current package name as path

packageNameAsPathFor

public static java.lang.String packageNameAsPathFor(java.lang.String qualified_name)

Returns the current package name as path

Parameters:

qualified_name - Description of Parameter

Returns:

current package name as path

packageName

public java.lang.String packageName()
                             throws XDocletException

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.

Returns:

current package name

Throws:

XDocletException - Description of Exception

packageOf

public void packageOf(java.lang.String template)
               throws XDocletException

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

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

forAllPackages

public void forAllPackages(java.lang.String template,
                           java.util.Properties attributes)
                    throws XDocletException

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

Parameters:

template - The body of the block tag

attributes - The attributes of the template tag

Throws:

XDocletException - Description of Exception

packageNameAsPath

public java.lang.String packageNameAsPath()
                                   throws XDocletException

Returns the current package name as path

Returns:

current package name as path

Throws:

XDocletException - Description of Exception