Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

xdoclet.tagshandler

Class PackageTagsHandler

public class PackageTagsHandler
extends xdoclet.tagshandler.AbstractProgramElementTagsHandler

Nested Class Summary

static class
PackageTagsHandler.PackageSubstitution

Field Summary

Fields inherited from class xdoclet.tagshandler.AbstractProgramElementTagsHandler

currentToken, matchPattern, tagTokenizer

Fields inherited from class xdoclet.XDocletTagSupport

FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER

Method Summary

void
forAllPackages(String template, Properties attributes)
static String
getPackageNameFor(String packageName)
static String
getPackageNameFor(String packageName, boolean withSubstitution)
static String
getPackageNameFor(XPackage pak, boolean withSubstitution)
static ArrayList
getPackageSubstitutions(String subtaskName)
void
packageDeclarationOf(String template)
String
packageName()
String
packageNameAsPath()
static String
packageNameAsPathFor(String qualifiedName)
static String
packageNameAsPathFor(XPackage pak)
static String
packageNameAsPathWithoutSubstitutionFor(XPackage pak)
void
packageOf(String template)
static String
replaceInline(String original, String oldOne, String newOne)

Methods inherited from class xdoclet.tagshandler.AbstractProgramElementTagsHandler

checkForWrap, currentToken, exceptionList, firstSentenceDescriptionOfCurrentMember, forAllMemberTagTokens, forAllMemberTags, forAllMembers, getAllClasses, getClassNameFor, getFullClassNameFor, getFullSuperclassNameFor, getIndentChars, getXExecutableMemberForMemberName, getXExecutableMemberForMemberName, hasExecutableMember, hasExecutableMember_OLD, makeCopyOfArray, matchValue, memberComment, setMatchValue, skipToken

Methods inherited from class xdoclet.XDocletTagSupport

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

Methods inherited from class xdoclet.template.TemplateTagHandler

getXJavaDoc, setXJavaDoc

Method Details

forAllPackages

public void forAllPackages(String template,
                           Properties attributes)
            throws xdoclet.XDocletException

getPackageNameFor

public static String getPackageNameFor(String packageName)

getPackageNameFor

public static String getPackageNameFor(String packageName,
                                       boolean withSubstitution)

getPackageNameFor

public static String getPackageNameFor(XPackage pak,
                                       boolean withSubstitution)

getPackageSubstitutions

public static ArrayList getPackageSubstitutions(String subtaskName)

packageDeclarationOf

public void packageDeclarationOf(String template)
            throws xdoclet.XDocletException

packageName

public String packageName()
            throws xdoclet.XDocletException

packageNameAsPath

public String packageNameAsPath()
            throws xdoclet.XDocletException

packageNameAsPathFor

public static String packageNameAsPathFor(String qualifiedName)

packageNameAsPathFor

public static String packageNameAsPathFor(XPackage pak)

packageNameAsPathWithoutSubstitutionFor

public static String packageNameAsPathWithoutSubstitutionFor(XPackage pak)

packageOf

public void packageOf(String template)
            throws xdoclet.XDocletException

replaceInline

public static String replaceInline(String original,
                                   String oldOne,
                                   String newOne)

Overview Package Class Use Tree Index Deprecated About
http://xdoclet.sourceforge.net/