xdoclet.tagshandler

Class PackageTagsHandler

public class PackageTagsHandler extends AbstractProgramElementTagsHandler

Tags which manipulate package names and packages, including substitutions.

Version: $Revision: 1.16 $

Author: Ara Abrahamian (ara_e@email.com)

UNKNOWN: Oct 14, 2001 namespace = "Package"

Nested Class Summary
static classPackageTagsHandler.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.
Method Summary
voidforAllPackages(String template, Properties attributes)
Iterates over all packages loaded by XJavadoc.
static StringgetPackageNameFor(XPackage pak, boolean withSubstitution)
Gets the name of a package, optionally applying any substitutions.
static StringgetPackageNameFor(String packageName)
Gets a package name with any subsitutions applied.
static StringgetPackageNameFor(String packageName, boolean withSubstitution)
Apply package substitutions.
static ArrayListgetPackageSubstitutions(String subtaskName)
Gets any PackageSubstitutions defined for a specified subtask.
voidpackageDeclarationOf(String template)
Writes the package declaration for the package name of the full-qualified class name specified in the body of this tag.
StringpackageName()
Returns the current package name.
StringpackageNameAsPath()
Returns the current package name as a path.
static StringpackageNameAsPathFor(XPackage pak)
Returns a package name as a path, after applying any substitutions.
static StringpackageNameAsPathFor(String qualifiedName)
Returns a package name as a path, after applying any substitutions.
static StringpackageNameAsPathWithoutSubstitutionFor(XPackage pak)
Returns a package name as a path, without applying any substitutions.
voidpackageOf(String template)
Returns the not-full-qualified package name of the full-qualified class name specified in the body of this tag.
static StringreplaceInline(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.

Method Detail

forAllPackages

public void forAllPackages(String template, Properties attributes)
Iterates over all packages loaded by XJavadoc. 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

UNKNOWN: type = "block" 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."

getPackageNameFor

public static String getPackageNameFor(XPackage pak, boolean withSubstitution)
Gets the name of a package, optionally applying any substitutions.

Parameters: pak package withSubstitution whether to apply any substitutions

Returns: package name

getPackageNameFor

public static String getPackageNameFor(String packageName)
Gets a package name with any subsitutions applied.

Parameters: packageName package name

Returns: package name

getPackageNameFor

public static String getPackageNameFor(String packageName, boolean withSubstitution)
Apply package substitutions. If useFirst is true , the first occurrence of substituteWith will be replaced by packages , else the one of the direct container of the current class.

Parameters: packageName The (current) package name, on which substitution shall take place. withSubstitution true if package substitutions shall take place.

Returns: The package name after substitutions.

getPackageSubstitutions

public static ArrayList getPackageSubstitutions(String subtaskName)
Gets any PackageSubstitutions defined for a specified subtask.

Parameters: subtaskName subtask name

Returns: ArrayList of substitutions

packageDeclarationOf

public 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. No package declaration is written if the full-qualified class name has no package.

Parameters: template The body of the block tag

Throws: XDocletException Description of Exception

UNKNOWN: type = "block"

packageName

public String packageName()
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

UNKNOWN: type = "content"

packageNameAsPath

public String packageNameAsPath()
Returns the current package name as a path.

Returns: current package name as path

Throws: XDocletException Description of Exception

UNKNOWN: type = "content"

packageNameAsPathFor

public static String packageNameAsPathFor(XPackage pak)
Returns a package name as a path, after applying any substitutions.

Parameters: pak package

Returns: package name as path

UNKNOWN: type = "content"

packageNameAsPathFor

public static String packageNameAsPathFor(String qualifiedName)
Returns a package name as a path, after applying any substitutions.

Parameters: qualifiedName package name

Returns: package name as path

UNKNOWN: type = "content"

packageNameAsPathWithoutSubstitutionFor

public static String packageNameAsPathWithoutSubstitutionFor(XPackage pak)
Returns a package name as a path, without applying any substitutions.

Parameters: pak package

Returns: package name as path

UNKNOWN: type = "content"

packageOf

public void packageOf(String template)
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

UNKNOWN: type = "block"

replaceInline

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

Parameters: original String in which replacement should occour oldOne String to be replaced newOne String that replaces

Returns: String original string with replacements