xdoclet.tagshandler
Class PackageTagsHandler

java.lang.Object
  extended byxdoclet.template.TemplateTagHandler
      extended byxdoclet.XDocletTagSupport
          extended byxdoclet.tagshandler.AbstractProgramElementTagsHandler
              extended byxdoclet.tagshandler.PackageTagsHandler

public class PackageTagsHandler
extends AbstractProgramElementTagsHandler

Version:
$Revision: 1.11 $
Author:
Ara Abrahamian (ara_e@email.com)
xdoclet.taghandler
namespace = "Package"
created
Oct 14, 2001

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 javadoc.
static String getPackageNameFor(String packageName)
           
static String getPackageNameFor(String packageName, boolean withSubstitution)
          It applies package substitutions.
static String getPackageNameFor(xjavadoc.XPackage pak, boolean withSubstitution)
          Gets the PackageNameFor attribute of the PackageTagsHandler class
static ArrayList getPackageSubstitutions(String subtaskName)
          Gets the PackageSubstitutions attribute of the PackageTagsHandler class
 String packageName()
          Returns the current package name.
 String packageNameAsPath()
          Returns the current package name as path
static String packageNameAsPathFor(String qualifiedName)
          Returns the current package name as path
static String packageNameAsPathFor(xjavadoc.XPackage pak)
          Returns the current package name as path
static String packageNameAsPathWithoutSubstitutionFor(xjavadoc.XPackage pak)
           
 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 occurance of oldOne in original with newOne Or returns the original string if oldOne is not found
 
Methods inherited from class xdoclet.tagshandler.AbstractProgramElementTagsHandler
checkForWrap, currentToken, exceptionList, firstSentenceDescriptionOfCurrentMember, forAllMembers, forAllMemberTags, forAllMemberTagTokens, getAllClasses, getClassNameFor, getFullClassNameFor, getFullSuperclassNameFor, getIndentChars, getXExecutableMemberForMemberName, getXExecutableMemberForMemberName, hasExecutableMember_OLD, hasExecutableMember, 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, hasTag, isTagValueEqual, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, modifiers, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
 
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

PackageTagsHandler

public PackageTagsHandler()
Method Detail

getPackageNameFor

public static String getPackageNameFor(xjavadoc.XPackage pak,
                                       boolean withSubstitution)
Gets the PackageNameFor attribute of the PackageTagsHandler class

Parameters:
pak - Describe what the parameter does
withSubstitution -
Returns:
The PackageNameFor value

getPackageNameFor

public static String getPackageNameFor(String packageName)

getPackageNameFor

public static String getPackageNameFor(String packageName,
                                       boolean withSubstitution)
It applies package substitutions.

Parameters:
packageName -
withSubstitution -
Returns:
The package name after substitutions.

getPackageSubstitutions

public static ArrayList getPackageSubstitutions(String subtaskName)
Gets the PackageSubstitutions attribute of the PackageTagsHandler class

Parameters:
subtaskName - Describe what the parameter does
Returns:
The PackageSubstitutions value

packageNameAsPathFor

public static String packageNameAsPathFor(xjavadoc.XPackage pak)
Returns the current package name as path

Parameters:
pak - Description of Parameter
Returns:
current package name as path
doc.tag
type = "content"

packageNameAsPathWithoutSubstitutionFor

public static String packageNameAsPathWithoutSubstitutionFor(xjavadoc.XPackage pak)

packageNameAsPathFor

public static String packageNameAsPathFor(String qualifiedName)
Returns the current package name as path

Parameters:
qualifiedName - Description of Parameter
Returns:
current package name as path
doc.tag
type = "content"

replaceInline

public static String replaceInline(String original,
                                   String oldOne,
                                   String newOne)
Replace the first occurance of oldOne in original with newOne Or returns the original string if oldOne is not found

Parameters:
original - String in which replacement should occour
oldOne - String to be replaced
newOne - String that replaces
Returns:
String original string with replacements

packageName

public 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
doc.tag
type = "content"

packageOf

public void packageOf(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
doc.tag
type = "block"

forAllPackages

public void forAllPackages(String template,
                           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
doc.tag
type = "block"
doc.param
name = "abstract" optional = "true" values = "true,false" description = "If true then accept * abstract classes also; otherwise don't.", name = "type" optional = "true" description = "For all classes by the type.", name = "extent" optional = "true" values = "concrete-type,superclass,hierarchy" description = "Specifies the extent of the type search. If concrete-type then only check the concrete type, if * superclass then check also superclass, if hierarchy then search the whole hierarchy and find if the class is * of the specified type. Default is hierarchy."

packageNameAsPath

public String packageNameAsPath()
                         throws XDocletException
Returns the current package name as path

Returns:
current package name as path
Throws:
XDocletException - Description of Exception
doc.tag
type = "content"

http://xdoclet.sourceforge.net/