Overview  Package   Class  Use  Deprecated  Index
Home >> All >> xdoclet >> [ tagshandler overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

xdoclet.tagshandler
Class PackageTagsHandler  

java.lang.Object
  xdoclet.template.TemplateTagHandler
      xdoclet.XDocletTagSupport
          xdoclet.tagshandler.AbstractProgramElementTagsHandler
              xdoclet.tagshandler.PackageTagsHandler

---

public class PackageTagsHandler

extends AbstractProgramElementTagsHandler

Tags which manipulate package names and packages, including substitutions.

Version:

$Revision: 1.16 $

---

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

 

Fields inherited from class xdoclet.template.TemplateTagHandler

 

Constructor Summary

PackageTagsHandler()

 

Method Summary
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(XPackage pak, boolean withSubstitution)           Gets the name of a package, optionally applying any substitutions.
private  java.lang.String	getPackageNameFrom(java.lang.String template)           Returns the package name for the full-qualified class name specified in the body of the passed tag.
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(XPackage pak)           Returns a package name as a path, after applying any substitutions.
static java.lang.String	packageNameAsPathWithoutSubstitutionFor(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.

 

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, 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

 

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 java.lang.String getPackageNameFor(XPackage pak,
                                                 boolean withSubstitution)

Gets the name of a package, optionally applying any substitutions.

---

getPackageNameFor

public static java.lang.String getPackageNameFor(java.lang.String packageName)

Gets a package name with any subsitutions applied.

---

getPackageSubstitutions

public static java.util.ArrayList getPackageSubstitutions(java.lang.String subtaskName)

Gets any PackageSubstitutions defined for a specified subtask.

---

packageNameAsPathFor

public static java.lang.String packageNameAsPathFor(XPackage pak)

Returns a package name as a path, after applying any substitutions.

---

packageNameAsPathWithoutSubstitutionFor

public static java.lang.String packageNameAsPathWithoutSubstitutionFor(XPackage pak)

Returns a package name as a path, without applying any substitutions.

---

replaceInline

public 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.

---

packageName

public java.lang.String packageName()
                             throws xdoclet.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.

---

packageOf

public void packageOf(java.lang.String template)
               throws xdoclet.XDocletException

Returns the not-full-qualified package name of the full-qualified class name specified in the body of this tag.

---

packageDeclarationOf

public void packageDeclarationOf(java.lang.String template)
                          throws xdoclet.XDocletException

Writes the package declaration for the package name of the full-qualified class name specified in the body of this tag. No package declaration is written if the full-qualified class name has no package.

---

forAllPackages

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

Iterates over all packages loaded by XJavadoc. Subsequent calls to forAllClasses will only iterate over the classes in the current package.

---

packageNameAsPath

public java.lang.String packageNameAsPath()
                                   throws xdoclet.XDocletException

Returns the current package name as a path.

---

getPackageNameFrom

private java.lang.String getPackageNameFrom(java.lang.String template)
                                     throws xdoclet.XDocletException

Returns the package name for the full-qualified class name specified in the body of the passed tag.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> xdoclet >> [ tagshandler overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---