xdoclet.tagshandler
public class PackageTagsHandler extends AbstractProgramElementTagsHandler
Modifier and Type | Class and Description |
---|---|
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.
|
currentToken, matchPattern, tagTokenizer
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER
Constructor and Description |
---|
PackageTagsHandler() |
Modifier and Type | Method and Description |
---|---|
void |
forAllPackages(java.lang.String template,
java.util.Properties attributes)
Iterates over all packages loaded by XJavadoc.
|
static java.lang.String |
getPackageNameFor(java.lang.String packageName)
Gets a package name with any subsitutions applied.
|
static java.lang.String |
getPackageNameFor(java.lang.String packageName,
boolean withSubstitution)
Apply package substitutions.
|
static java.lang.String |
getPackageNameFor(xjavadoc.XPackage pak,
boolean withSubstitution)
Gets the name of a package, optionally applying any substitutions.
|
static java.util.ArrayList |
getPackageSubstitutions(java.lang.String subtaskName)
Gets any PackageSubstitutions defined for a specified subtask.
|
void |
packageDeclarationOf(java.lang.String template)
Writes the package declaration for the package name of the full-qualified class name specified in the body of
this tag.
|
java.lang.String |
packageName()
Returns the current package name.
|
java.lang.String |
packageNameAsPath()
Returns the current package name as a path.
|
static java.lang.String |
packageNameAsPathFor(java.lang.String qualifiedName)
Returns a package name as a path, after applying any substitutions.
|
static java.lang.String |
packageNameAsPathFor(xjavadoc.XPackage pak)
Returns a package name as a path, after applying any substitutions.
|
static java.lang.String |
packageNameAsPathWithoutSubstitutionFor(xjavadoc.XPackage pak)
Returns a package name as a path, without applying any substitutions.
|
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.
|
static java.lang.String |
replaceInline(java.lang.String original,
java.lang.String oldOne,
java.lang.String newOne)
Replace the first occurrence of
oldOne in original with newOne , or returns
the original string if oldOne is not found. |
checkForWrap, currentToken, exceptionList, firstSentenceDescriptionOfCurrentMember, forAllMembers, forAllMemberTags, forAllMemberTagTokens, getAllClasses, getClassNameFor, getFullClassNameFor, getFullSuperclassNameFor, getIndentChars, getXExecutableMemberForMemberName, getXExecutableMemberForMemberName, hasExecutableMember_OLD, hasExecutableMember, makeCopyOfArray, matchValue, memberComment, setMatchValue, skipToken
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
getXJavaDoc, setXJavaDoc
public static java.lang.String getPackageNameFor(xjavadoc.XPackage pak, boolean withSubstitution)
pak
- packagewithSubstitution
- whether to apply any substitutionspublic static java.lang.String getPackageNameFor(java.lang.String packageName)
packageName
- package namepublic static java.lang.String getPackageNameFor(java.lang.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 java.util.ArrayList getPackageSubstitutions(java.lang.String subtaskName)
subtaskName
- subtask namepublic static java.lang.String packageNameAsPathFor(xjavadoc.XPackage pak)
pak
- packagepublic static java.lang.String packageNameAsPathWithoutSubstitutionFor(xjavadoc.XPackage pak)
pak
- packagepublic static java.lang.String packageNameAsPathFor(java.lang.String qualifiedName)
qualifiedName
- package namepublic static java.lang.String replaceInline(java.lang.String original, java.lang.String oldOne, java.lang.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 replacespublic java.lang.String packageName() throws XDocletException
XDocletException
- Description of Exceptionpublic void packageOf(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
- Description of Exceptionpublic void packageDeclarationOf(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
- 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 tagXDocletException
- Description of Exceptionpublic java.lang.String packageNameAsPath() throws XDocletException
XDocletException
- Description of Exception