|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.template.TemplateTagHandler
xdoclet.XDocletTagSupport
xdoclet.tagshandler.AbstractProgramElementTagsHandler
xdoclet.tagshandler.PackageTagsHandler
Tags which manipulate package names and packages, including substitutions.
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(String template,
Properties attributes)
Iterates over all packages loaded by XJavadoc. |
static String |
getPackageNameFor(String packageName)
Gets a package name with any subsitutions applied. |
static String |
getPackageNameFor(String packageName,
boolean withSubstitution)
Apply package substitutions. |
static String |
getPackageNameFor(xjavadoc.XPackage pak,
boolean withSubstitution)
Gets the name of a package, optionally applying any substitutions. |
static ArrayList |
getPackageSubstitutions(String subtaskName)
Gets any PackageSubstitutions defined for a specified subtask. |
void |
packageDeclarationOf(String template)
Writes the package declaration for the package name of the full-qualified class name specified in the body of this tag. |
String |
packageName()
Returns the current package name. |
String |
packageNameAsPath()
Returns the current package name as a path. |
static String |
packageNameAsPathFor(String qualifiedName)
Returns a package name as a path, after applying any substitutions. |
static String |
packageNameAsPathFor(xjavadoc.XPackage pak)
Returns a package name as a path, after applying any substitutions. |
static String |
packageNameAsPathWithoutSubstitutionFor(xjavadoc.XPackage pak)
Returns a package name as a path, without applying any substitutions. |
void |
packageOf(String template)
Returns the not-full-qualified package name of the full-qualified class name specified in the body of this tag. |
static String |
replaceInline(String original,
String oldOne,
String newOne)
Replace the first occurrence of oldOne in original with newOne , or returns
the original string if oldOne is not found. |
Methods inherited from class xdoclet.template.TemplateTagHandler |
getXJavaDoc, setXJavaDoc |
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 String getPackageNameFor(xjavadoc.XPackage pak, boolean withSubstitution)
pak
- packagewithSubstitution
- whether to apply any substitutions
public static String getPackageNameFor(String packageName)
packageName
- package name
public static String getPackageNameFor(String packageName, boolean withSubstitution)
packageName
- The (current) package name, on which substitution shall take place.withSubstitution
- true if package substitutions shall take place.
public static ArrayList getPackageSubstitutions(String subtaskName)
subtaskName
- subtask name
public static String packageNameAsPathFor(xjavadoc.XPackage pak)
pak
- package
public static String packageNameAsPathWithoutSubstitutionFor(xjavadoc.XPackage pak)
pak
- package
public static String packageNameAsPathFor(String qualifiedName)
qualifiedName
- package name
public static String replaceInline(String original, String oldOne, String newOne)
oldOne
in original
with newOne
, or returns
the original string if oldOne
is not found.
original
- String in which replacement should occouroldOne
- String to be replacednewOne
- String that replaces
public String packageName() throws XDocletException
XDocletException
- Description of Exceptionpublic void packageOf(String template) throws XDocletException
template
- The body of the block tag
XDocletException
- Description of Exceptionpublic void packageDeclarationOf(String template) throws XDocletException
template
- The body of the block tag
XDocletException
- Description of Exceptionpublic void forAllPackages(String template, Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exceptionpublic String packageNameAsPath() throws XDocletException
XDocletException
- Description of Exception
|
http://xdoclet.sourceforge.net/ | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |