|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--xdoclet.template.TemplateTagHandler | +--xdoclet.XDocletTagSupport | +--xdoclet.tagshandler.AbstractProgramElementTagsHandler | +--xdoclet.tagshandler.PackageTagsHandler
Nested Class Summary | |
static class |
PackageTagsHandler.PackageSubstitution
It's good practice to put interfaces (such as remote/local interfaces, data objects and home interfaces) in a separate "interfaces" package rather than in the EJB bean implementation package. |
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 |
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(java.lang.String packageName)
|
static java.lang.String |
getPackageNameFor(java.lang.String packageName,
boolean withSubstitution)
It applies package substitutions. |
static java.lang.String |
getPackageNameFor(xjavadoc.XPackage pak,
boolean withSubstitution)
Gets the PackageNameFor attribute of the PackageTagsHandler class |
static java.util.ArrayList |
getPackageSubstitutions(java.lang.String subtaskName)
Gets the PackageSubstitutions attribute of the PackageTagsHandler class |
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(java.lang.String qualifiedName)
Returns the current package name as path |
static java.lang.String |
packageNameAsPathFor(xjavadoc.XPackage pak)
Returns the current package name as path |
static java.lang.String |
packageNameAsPathWithoutSubstitutionFor(xjavadoc.XPackage pak)
|
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public PackageTagsHandler()
Method Detail |
public static java.lang.String getPackageNameFor(xjavadoc.XPackage pak, boolean withSubstitution)
pak
- Describe what the parameter doeswithSubstitution
-
public static java.lang.String getPackageNameFor(java.lang.String packageName)
public static java.lang.String getPackageNameFor(java.lang.String packageName, boolean withSubstitution)
packageName
- withSubstitution
-
public static java.util.ArrayList getPackageSubstitutions(java.lang.String subtaskName)
subtaskName
- Describe what the parameter does
public static java.lang.String packageNameAsPathFor(xjavadoc.XPackage pak)
pak
- Description of Parameter
public static java.lang.String packageNameAsPathWithoutSubstitutionFor(xjavadoc.XPackage pak)
public static java.lang.String packageNameAsPathFor(java.lang.String qualifiedName)
qualifiedName
- Description of Parameter
public java.lang.String packageName() throws XDocletException
XDocletException
- Description of Exceptionpublic void packageOf(java.lang.String template) throws XDocletException
template
- The body of the block tag
XDocletException
- Description of Exceptionpublic void forAllPackages(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exceptionpublic java.lang.String packageNameAsPath() throws XDocletException
XDocletException
- Description of Exception
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |